Request and Responses

Overview

Glider's API enables businesses to create, send, or schedule 'invoice' campaigns and securely manage customer information with a single API call. Additionally, our comprehensive Report APIs provide real-time updates on active campaign statuses and transaction details, along with valuable insights into customer behaviour and preferences.

Authentication

To interact with the Glider API, you must include an API Key Bearer token in your requests to authenticate and associate the request with your account.

Getting Your API Key

To obtain your API key, follow this guide.

Headers

Each request must include the following header:

Authorization: Bearer <API KEY HERE>

The Content-Type header varies depending on the API request. The default is application/json, unless otherwise specified in the API reference for the specific request.

Example:

Content-type: <type here>

Responses

Responses from the API adhere to the JSON API v1.0 specification. Here are the most common HTTP status codes you may encounter:

Status code	Title	Details
200	OK	The request was successful.
201	Created	The request was successful, and a new resource was created.
204	No Content	The request was successful, and a resource was modified.
400	Bad Request	The request could not be understood or was missing required parameters. Check the response body for details.
403	Forbidden	Authentication failed or the user does not have permissions for the requested operation. Verify the API token.
404	Not Found	The requested resource was not found. This may be due to a non-existent ID.
500	Internal Server Error	An error occurred on the server. Please contact [email protected] with your API request and customer_id.

Response Body

All Glider API responses are in JSON format. Successful responses are detailed in the API documentation. Error responses follow a similar structure, with details provided in the response body:

HTTP <error code> <error title>
{
   "error": "<error message details here>"
}