API Design

SideDrawer APIs are equipped with resource-oriented URLs, accept form-encoded request bodies, return JSON-encoded responses, and use standard HTTP response codes, authentication, and verbs.

You can use the SideDrawer API for free in Sandbox mode – this does not affect your data in Production mode, nor does it interact with any of your SideDrawer production instances. It is simply an environment that offers limited functionality for testing purposes.

Production mode offers full access to every feature of your selected plan, and begins processing live requests when in use.

🚧
Modes
The API key you use to authenticate requests will determine whether the request is in Sandbox or Production mode. Obtain API keys for the Sandbox and Production environments by signing up for a SideDrawer account on the SideDrawer Dashboard.

API Protocol

The SideDrawer API follows the REST standard, taking advantage of HTTP methodologies defined by the RFC 2616 protocol. It uses GET/POST requests to communicate and HTTP response codes to indicate statuses and errors.

All responses come in standard JSON and all requests must include the Content-Type: application/json header and, when applicable, a valid JSON body.

❗️
Security Protocols
The API supports only secure communications over HTTPS TLS v1.2 to ensure data privacy. HTTP or HTTPS with TLS under v1.2 are not supported and will be rejected.

API Base URL

All endpoints in the reference documentation use the following base URL:

https://api-sbx.sidedrawersbx.com/