Swift Messaging API
Previous page Swift Go API Reference
Next pageAuthentication
Swift Messaging API enables your back-office applications to communicate with any Swift counterparty through Alliance Cloud by embedding Swift messages inside API calls. To learn more about this API, see Swift Messaging API Overview. In this section, you will find the technical implementation details on how to integrate with Swift Messaging API.
Refer to the Swift Messaging API Reference and Swift messaging API Getting Started Guide to help you integrate the API.
Swift Messaging API includes endpoints supporting . Identify the API endpoints by searching for in the request header and in the response header in the OpenAPI specification.
Looking for a faster and easier way to integrate? Consider using one of the developer tools designed to simplify the consumption of API-based services available on the Swift platform. Build your application with Swift SDK to help you with lower-level application plumbing, which includes authentication, authorisation, signing and error handling. Alternatively, consider using Swift Microgateway to configure, monitor all API calls you make on Swift and capture inbound API requests. Finally, Swift zero-footprint is an option that provides reference implementations so that you can create your own SDK or utilities.
Not sure which tool is right for you? Try the connectivity option selector to get recommendations from our expert. After you select a tool, try setting it up in the API sandbox (available over the Internet) to quickly get started.
Swift Messaging API sandbox returns static sample responses and does not contain any application logic. This sandbox is recommended for developers who want to learn and understand the authentication method JWT Bearer Grant Type by testing it out with a self-signed certificate over the Internet. This sandbox also ensures that the application generates valid requests and can consume valid responses conforming to OpenAPI specifications. It is also recommended for developers who are trying to set up the developer tools aimed to make integration easier.
You can view, fork or download the Postman collection which includes authentication API calls and sample Swift Messaging API calls. Also refer to access sandbox where dedicated sandbox credentials are provided. To start testing in the sandbox, create an app and select Swift Messaging API.
In the Swift Messaging API Postman Collection, there is a call titled "Mock Upload" which mocks the transfer of a FileAct message. To make this API call in Postman, it will require you to upload a small text file in the body field file.
We have provided a sample file below.
| File | Value | Descriptions |
|---|---|---|
| Sample Text File | For use in Swift Messaging API postman collection Mock Upload. For the field file in Mock Upload, you can select this file from your machine. |
The Swift Pilot environment closely resembles the Live environment. It is intended to fully qualify your API integration. Make sure you are subscribed to Alliance Cloud. Follow the steps below to access the Swift Messaging API Pilot testing environment.
Create a dedicated app for testing in the Pilot environment and select Swift Messaging API from the list of API products. Inside the app are consumer-key and consumer-secret which are the application credentials used to identify the application calling the API. After creating the app, promote the app to the Pilot environment.
Swift Messaging API supports the use of Channel certificates when signing the JWT in the authorisation API call. After creating the certificate, assign the RBAC role swift.alliancecloud.api!p to the certificate.
This step should be completed by a security officerAlliance Lite2 Customer Security Officer. Click to learn more on Swift.com..
After completing the steps above, you now have the credentials you need to access the Swift Messaging API in the Pilot environment. Refer to Authentication to learn how to use the credentials you created above to start testing your integration with Swift Messaging API in Pilot.
After successfully testing the Swift Messaging API in Pilot, follow the steps below to start using the Swift Messaging API in Live.
Promote the app you created to the Live environment or create a new app for the Live environment. If you decided to create a new app, select Swift Messaging API from the list of API products. After creating the app, promote the app to the Live environment.
You should promote the app to Pilot first and then Live.
Follow the same process for creating the certificate for Pilot testing. The Swift Messaging API supports the use of Channel certificates when signing the JWT in the authorisation API call. After creating the certificate, assign the RBAC role swift.alliancecloud.api to the certificate for Live.
This step should be completed by a security officerAlliance Lite2 Customer Security Officer. Click to learn more on Swift.com..
Swap out the credentials you used for Pilot with Live credentials and start using the Swift Messaging API in your Live applications. When in doubt, refer to Authentication to learn how to use your Live credentials to access the Swift Messaging API in Live.