Open API
This document is about how to prepare, sign and fire an API Call to the API Gateway of SwiftFederation solutions.
REST APIs of SwiftFederation solutions provide a rich set of options for developers to integrate with their service systems to:
- Onboard new customers and services
- Securely authenticate and authorise
- Access and manage user accounts and data
- Handle business logic and transactions
- Configure and optimise the services
Key Features
| Feature | Description |
|---|---|
| Quick Start | Illustrates the steps of preparing, signing and making the API calls as a quick start. |
| Making API Requests | Introduces how to make an API call to the REST APIs of SwiftFederation solutions: - Common Requests: defines the request structure as well as the signature. - Request Parameters: describes the parameters in path, query, headers, cookie and request body. - Signature: explains the algorithm details to sign the API request. - Signature Toolkit: provides an online signature toolkit to assist the client in verifying the signature. - Common Response: defines the response structure when receiving the returned data from the REST APIs. |
| API Catalog | Provides a comprehensive list of all available APIs for the xxx solution. APIs are categorised based on features. |
| Common Errors | List the errors in the responses from the REST APIs of SwiftFederation solutions. |
| Status Codes | Elaborates on the status codes and reason phrases in the responses. |
| Support | Shows the support available when you have any questions when using the APIs. |