Skip to main content

Authentication

Itqan APIs use an API key to identify your application. Public read endpoints currently work without one, but we recommend creating a key now — it unlocks account-aware features, higher rate limits, and keeps your integration ready as authentication rolls out more widely.

Get an API key

  1. Sign in to the Asset Library at cms.itqan.dev.
  2. Open your account settings and go to API Keys.
  3. Create a key, give it a descriptive name (e.g. my-recitation-app), and copy it.

Store it securely. Treat the key like a password — keep it in an environment variable or secret manager, never commit it to source control or expose it in client-side code.

Send the key

Pass your key on every request in the X-API-Key header:

curl https://api.cms.itqan.dev/reciters/ \
-H "X-API-Key: YOUR_API_KEY"

Errors

A missing or invalid key returns an error in the standard error format:

StatusMeaningFix
401 UnauthorizedKey is missing or malformedAdd a valid X-API-Key header
403 ForbiddenKey is valid but not allowed for this resourceCheck the key's permissions in the Asset Library

Existing integrations against public read endpoints continue to work without disruption while the key requirement is phased in.


See also: Quickstart · Error Handling