REST API

Authenticating requests

Authentication is done by passing an API token in the Authorization header of your HTTP request:

Authorization: Bearer <api-token>

API reference

Swagger documentation is published with all available endpoints:

Formatting request arguments

There are two ways to pass arguments to an endpoint:

  1. URL encoding (Key-Value Pairs) – Used in GET requests.

  2. JSON encoding (Request Body) – Used in POST requests.

The method depends on the endpoint, but generally:

  • GET requests → Use URL encoding.

  • POST requests → Use JSON encoding.

import requests

# URL encoding for a GET request
params = {"key1": "value1", "key2": "value2"}
response = requests.get("https://api.example.com/endpoint", params=params)

# JSON encoding for a POST request
data = {"key1": "value1", "key2": "value2"}
response = requests.post("https://api.example.com/endpoint", json=data)

This ensures proper data formatting based on the request type.

Last updated