REST API Overview

Welcome to the Heldsway REST API documentation.

Our REST API allows you to programmatically manage your affiliate programs, track conversions server-side, and retrieve analytics data.

Base URL

All API requests should be prefixed with the following base URL:

https://heldsway.com/api/

Obtaining API Credentials

API keys are issued from the Heldsway admin panel. You will receive:

• api_key — public identifier (safe to log)
• api_secret — sensitive secret (treat like a password, never expose client-side)

Each key carries a set of scopes that determine which endpoints it can access. The issued token inherits these scopes.

Rate Limiting

Our endpoints are throttled to ensure system stability. Typically, endpoints are throttled at 120 requests per minute per IP address or token.

Exceeding the limit will result in an HTTP 429 Too Many Requests response.