...
Flexiti’s API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes that indicate errors in simple language.
Environments
Developers have access to three different environments: MERCHANT INTEGRATION, TRAINING, and PRODUCTION.
All API requests exist in MERCHANT INTEGRATION, TRAINING, and PRODUCTION environments. All objects - customers, plans, transactions, etc. created in one environment do not exist in the others.
Our MERCHANT INTEGRATION environment:
| Info |
|---|
We suggest Developers use our Merchant Integration environment for POS API implementations. |
This environment is a persistent sandbox for integrating Flexiti’s POS API and testing against upcoming Flexiti releases.
We also introduce pre-release code to this environment to give Merchants an opportunity to integrate the new features and functionality ahead of our Production release.
Unlike our TRAINING environment, it is not scrubbed daily and test data persists in this environment.
Here is our API Changelog & Release Schedule - 2021
Resources:
Developer Portal Account Creation: https://developer-mi.flexiti.fi
| Note |
|---|
Our Merchant Integration environment has a standing maintenance window scheduled Monday and Wednesday mornings. Implementation teams can expect some instability during this time. |
Our TRAINING environment:
This environment is a sandbox for testing that uses the same code base as our current production environment.
Transactions and customer accounts generated in this environment are treated as test objects and is test data is scrubbed daily.
Resources:
Developer Portal Account Creation: https://developer.flexiti.f
API URL: https://posapi-training.flexiti.fi/flexiti/pos-api/
| Note |
|---|
Maintenance windows in our Training environment will be communicated ahead of time. |
Our PRODUCTION environment:
This environment is the “Live” production environment.
Customer accounts generated in this environment hit the Credit Bureau and any Transactional data generated is real.
Resources:
| Note |
|---|
Maintenance windows in our Production environment will be communicated ahead of time. |
Authentication
The Flexiti API uses API keys to authenticate requests. Your keys consist of a Client ID and a Client Secret. You can view and manage your API keys in the Development Portal. If you do not include your keys when making an API request, or use one that is incorrect, Flexiti returns an error.
...
Provide your API keys to generate a Bearer Token that needs to be used as part of every future request.
Obtaining your Flexiti API Keys
...
Create a Developer Portal Account(s) to receive your API keys:
...
Review the API documentation
...
Use your credentials using Postman or Swagger
...
...
Implement the PROD (live) version on your Production environment and review
Errors
Flexiti uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a transaction failed, etc.). Codes in the 5xx range indicates an error with Flexiti's servers.
...
When we make backwards-incompatible changes to the API, we release new versions. The current version is version 2.5. A Change log can be found here -: https://flexiti.atlassian.net/wiki/x/GQCRAg
...
Adding new API endpoints
Adding new parameters to existing endpoints
Adding new data elements to existing response schema
Adding new error types and error response codes
Changing the length or content of any API parameter
...
Read More:
| Child pages (Children Display) |
|---|