Relationship Management API enables customer's applications to query authorisation related information stored in the central RMA data store. To learn more about this API, see Relationship Management API Overview. In this section, you will find the technical implementation details on how to integrate with Relationship Management API.

OpenAPI specification

Refer to the Relationship Management API Reference to help you integrate the API.

Choose developer tools

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.

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.

Test Relationship Management API in the Sandbox

Relationship Management 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 Relationship Management API calls. Also refer to access sandbox where dedicated sandbox credentials are provided. To start testing in the sandbox, create an app and select Relationship Management API.

Test Relationship Management API in Pilot

Swift Pilot environment closely resembles the Live environment. It is intended to fully qualify your API integration. Make sure you are subscribed to Relationship Management APIs. Follow the steps below to access the Relationship Management API Pilot testing environment.

Step 1: Submit e-order

Step 2: Create an app for Pilot

Create a dedicated app for testing in the Pilot environment and select Relationship Management 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.

Step 3: Create Certificate & assign RBAC role for Pilot

Relationship Management API supports the use of Business certificates when signing the JWT in the authorisation API call. After creating the certificate, assign the RBAC role swift.rma.api!p to the certificate.

Step 4: Making your first test API call in the Pilot environment

After completing the steps above, you now have the credentials you need to access the Relationship Management API in the Pilot environment. Refer to Authentication to learn how to use the credentials you created above to start testing your integration with this API in Pilot.

Go Live

After successfully testing the Relationship Management API in Pilot, follow the steps below to start using this API in Live.

Step 1: Submit e-order

Step 2: Create an app for 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 Relationship Management API from the list of API products. After creating the app, promote the app to the Live environment.

Step 3: Create Certificate & assign RBAC role for Live

Follow the same process for creating the certificate for Pilot testing. Relationship Management API supports the use of Business certificates when signing the JWT in the authorisation API call. After the certificate is created, assign the RBAC role swift.rma.api to the certificate for Live.

Step 4: Making your first test API call in Live

Swap out the credentials you used for Pilot with Live credentials and start using the Relationship Management API in your Live applications. When in doubt, refer to Authentication to learn how to use your Live credentials to access this API in Live.