Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

...

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

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

...

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