API Authentication

All API requests require an API key passed in the X-Api-Key header. API keys are scoped to your account and can be issued, listed, and revoked through the admin portal.

X-Api-Key: <your-api-key>

Obtaining an API key

1. Sign in to the admin portal.
2. Navigate to Tokens.
3. Click Issue Token.
4. Copy the generated token — it will only be shown once.

Using the token

Include the token in every API request as the X-Api-Key header:

curl -X POST https://api.pushtodisplay.com/api/v1/updates \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: ptd_your_token_here" \
  -d '{ "blocks": [{ "text": "Hello" }] }'

Token management

You can manage tokens through the admin portal:

• List all active tokens for your account
• Issue new tokens at any time
• Revoke tokens that are no longer needed or may have been compromised

Revoking a token takes effect immediately — any subsequent requests using that token will receive a 401 Unauthorized response.