Authentication and environments

Create, protect, rotate, and revoke a Humanbased API Key for production or Sandbox.

Humanbased API integrations use API Keys. Create a Key in the Developer Portal and send it as a Bearer token with every authenticated request.

Authorization: Bearer YOUR_API_KEY

Create a production API Key

Sign in to the Developer Portal.
Open API Keys.
Select Create API Key.
Enter a clear name and expiration date.
For a production Key, select the scopes the integration requires — a Subscription scope for data delivery, a Campaign scope for the Campaign API.
Create the Key.
Copy it when it appears and save it in a secrets manager.

The full Key is shown only when it is created. Do not include a real Key, account name, email address, or Organization name in a public screenshot.

Production and Sandbox Keys

A Production API Key grants production data access according to its selected Subscription scopes.
A Sandbox Key is for simulated data and cannot authenticate to the production API.

Changing the Portal environment selector does not convert a production object into a Sandbox object. Create the Key that matches the target API and data environment.

Protect the Key

Store it in a server-side environment variable or secrets manager.
Do not put it in browser code, a mobile app, source control, screenshots, or support messages.
Use a different Key for each service and environment.
Grant only the access the integration needs.
Rotate regularly and immediately after suspected exposure.

Use the Key

curl "https://api.humanbased.ai/v1/RESOURCE" \
  -H "Authorization: Bearer $HUMANBASED_API_KEY"

See API Reference for endpoints and request formats.

Errors and retries

Humanbased does not currently publish one fixed request quota that applies to every endpoint. Limits can vary by endpoint, access level, and service conditions.

When the API returns 429 Too Many Requests:

Stop immediate retries.
Honor Retry-After when the response includes it.
Otherwise use exponential backoff with randomized jitter.
Cap retries and surface a recoverable error to the calling service.
Cache stable responses and avoid unnecessary polling.

Contact Humanbased through the support channel available in your Portal when an integration needs a sustained request volume beyond its current allowance.

Revoke a Key from API Keys in the Developer Portal. Revocation cannot be undone. To avoid an interruption, first create a replacement, update and verify the integration, and then revoke the old Key.

An API Key authorizes an integration. A Portal login session is not an API credential.