API overview

Next

Welcome to the API documentation. The API is a RESTful service designed to help you integrate quickly and reliably with our platform.

The API uses predictable, resource-oriented URLs, accepts form-encoded request bodies, and returns JSON-encoded responses. It also leverages standard HTTP response codes, verbs, and authentication methods, making integration familiar for developers.

To help you get started, this documentation walks you through the essentials:

  • Environments: Understand the difference between test and production environments

  • Authentication: Learn how to securely connect to our API using your credentials

  • Response codes: Understand error codes and responses

  • First API call: Example of your first API call in just a few steps

  • Batch integration: Parameters used to retrieve list of resources from the API

  • FAQs: Answers to common integration questions