API Consumers
For developers, architects, and technical teams who want to consume APIs exposed through the Swift API platform.
For developers, architects, and technical teams who want to consume APIs exposed through the Swift API platform.
The Swift Developer Portal is the central place for API consumers to discover, evaluate, and integrate with APIs available on the Swift API platform. Whether you are exploring an API for the first time or preparing for production integration, this portal provides the documentation, tools, and guidance you need to get started quickly and confidently.
Begin by identifying the API that best fits your use case. Each API page from the API catalogue provides functional descriptions, use cases, and technical details to help you evaluate whether it meets your business and integration needs.
Before integrating, it is important to understand which network the API is exposed from, such as:
Internet-facing
MV-SIPN
Knowing the network exposure helps you align your business needs, determine connectivity requirements, and deployment considerations early in the evaluation process.
Each API clearly documents the credentials and security mechanisms required for access. These include:
Custom request headers such as X-SWIFT-Signature
Understanding these requirements is essential for assessing integration complexity, your environment readiness and available connectivity options to ease the integration effort.
Once network and credential requirements are clear, you can evaluate the developer resources available to support your integration, such as:
API specifications under API Guides including sample requests and responses
API connectivity options such as Swift Microgateway, Swift SDK and Swift zero-footprint
Sandbox and Pilot testing environments
All APIs include documented error codes and error response formats. Error codes are standardised and clearly explained so that you can handle the errors in a consistent manner and debug quickly. You can reference error documentation at any time during development or troubleshooting.