...
This guide will help you identify the steps required to use the Flexiti’s API. The information provided by the API will allow a comprehensive integration of the Flexiti features with your system, and provide a real-time back and forth between your system and Flexiti’s.
Channels
Our API is designed to work for both in-store and ecommerce integrations and we have two “channels” to support this. Each channel uses the same endpoints with slight changes in paramters.
“In-store” - denotes in-store point of sale integrations where the customer is present
“Online” - denotes online ecommerce integrations where the customer is not present
Technology
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.
...
Every account is provided with two sets of keys . One for testing in our TRAINING environment and one for running live transactions in our PRODUCTION for each environment.
Please note that the API requires a series of steps for the purpose of securing the connection between servers; as well as define certain parameters such as the Trust URL (or IP.)
...
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
Go to our Developer Portal
Create a Developer Portal Account to receive API keys and set up your trust URL (or IP).
Be sure to keep them secure!
Review the API documentation
Use your credentials using Postman or Swagger
Implement the TRAINING (test) version on your Staging environment and test thoroughly
Implement the PROD (live) version on your Production environment and review
TRAINING and PRODUCTION environments
All API requests exist in both TRAINING and PRODUCTION environments, and objects - customers, plans, transactions, and so forth created in one environment do not exist in the other. The TRAINING and PRODUCTION environments function almost identically, with a few necessary differences.In our TRAINING environment:
transactions and customer accounts generated in this environment are only treated as test objects.
our training environment is scrubbed from time to time
This environment is considered a “test” environment
References: https://posapi-training.flexiti.fi/flexiti/pos-api/v2.5
In our PRODUCTION environment:
Customer accounts generated in this environment hit the Credit Bureau
Transactional data generated in this environment are stored in Flexiti’s production systems
This environment is considered a “Live” production environment
References: https://posapi.flexiti.fi/flexiti/pos-api/v2.5
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 Changelog Change log can be found here -: https://flexiti.atlassian.net/wiki/x/GQCRAg
We strive to avoid making any changes to our API that will break the contract, but we do make changes over time that may result in changes to the data that you request from us.
We consider the following changes to be backwards compatible:
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) |
|---|