Calling the API

This document provides instructions on how to use an API token to authenticate your API requests by including it in the Authorization header. API tokens are a secure way to authenticate requests without using username and password combinations.

Prerequisites

An API token https://developer.getcacheflow.com/docs/create-an-api-token
A basic understanding of making HTTP requests.
A tool or library to make HTTP requests (e.g., cURL, Postman, Python requests, etc.).

Using the Authorization Header

The API token should be included in the Authorization header of your HTTP request. The header format is as follows:

Authorization: Bearer <your_api_token>

Replace <your_api_token> with your actual API token.

API endpoints

production: https://<org_domain>.api.getcacheflow.com

sandbox: https://<org_domain>.sandbox.api.getcacheflow.com

The endpoint url is prefixed with a unique subdomain for your organization.

Example: If your org domain is example the api endpoint would be:

https://example.api.getcacheflow.com