Step 1: Get Credentials
Once you have completed the commercial agreement with Simplex and begun the on-boarding process, you will be provided with an API Key.
Initially the API key will be for our 'sandbox' or test environment. Once you have completed integration and it has been approved by our integration team, they will issue an API key for the Production environment.
Authentication
- Simplex will issue a REST API key for each partner. Each API key can be used only from a defined server static IP list. The partner will need to use the correct API key on each location.
- API keys will be delivered to partner upon request from Simplex’s technical support team.
- The authentication mechanism is based on API key, which means simple comparison of the API key in the HTTP header to the list of partners’ API keys that Simplex holds. In addition - Simplex verifies that IP matches for the API key.
- The partner should take great care to ensure their credentials are not compromised.
- It is obligatory not to store these credentials in the code base (which gets added to version control). These credentials must not be stored on the client side.
- All requests must be authenticated, and all API requests must be made over HTTPS. Calls over plain HTTP will fail.
Updated over 1 year ago
Did this page help you?