Skip to content
Aureus PrimeDocs

API reference

Authentication

Every call carries your API key in the Authorization header:

Authorization: Bearer adk_sms_YOUR_KEY

No key, or a revoked key: 401 AUTH_REQUIRED. Suspended account: 403 ACCOUNT_SUSPENDED.

Your keys

  • A key is tied to your SMS account: it only sees and spends your credits.
  • It is shown only once, when it is created. Aureus Desk keeps only a fingerprint of it: it cannot be retrieved afterwards.
  • You can have 2 active keys at most. Creating a third one is refused (409 API_KEY_LIMIT).

Changing keys without downtime

  1. Create a second key.
  2. Deploy it to your servers.
  3. Revoke the old one in the account area.

Environments

Today there is only one environment, production: every successful call to POST /sms/messages sends a real SMS and consumes credit. There is no test environment or test key yet.

For your tests:

  • send to your own number;
  • use a key dedicated to testing, which you will revoke afterwards;
  • check your requests with the rejections returned before sending (4xx), which never debit any credit.

The creation of a test environment will be announced in the changelog.

Good rules

  • Keep the key server-side: never in a mobile app, a web page or a code repository.
  • An exposed key must be revoked immediately: messages sent with it are charged to you.