The FlatPeak API follows REST principles, using resource-oriented URLs, form-encoded request bodies, JSON responses, standard HTTP verbs, authentication methods, and status codes for predictable, consistent interactions.

  • The API also supports a test (sandbox) mode, allowing you to validate your integration without affecting your live data. The API key used in the request determines whether you’re operating in test or live mode. Test keys are prefixed sk_test_, live keys sk_live_.

  • Note that Connect group of methods work differently from standard API calls. They use a single endpoint that communicates through a structured sequence of JSON-formatted questions and responses, similar to a chatbot interaction. Access is authorised via a single-use connect_token, and your integration must handle every method the endpoint supports. Refer to Connect guide for more information.