إنتقل إلى المحتوى الرئيسي
Version: 1.0.0

Itqan CMS Public APIs

REST API for Quranic recitation data — reciters, recitations, riwayat, qira'at, and ayah-level audio timings from verified publishers.

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.
  4. 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 in the X-API-Key header on each request.

Identifying your app

Two optional headers let you tell us which build of your application is calling, so an error can be traced back to the release that introduced it:

  • X-Client-Name — a stable identifier for your app, e.g. quran-companion (max 64 chars of A-Z a-z 0-9 . _ -)
  • X-Client-Version — the version making the call, e.g. 2.4.1 (max 32 chars of A-Z a-z 0-9 . _ + -; semver pre-release and build metadata are accepted)

Neither header affects the response, your rate limit, or authentication. A malformed value is ignored rather than rejected, and the response carries an X-Itqan-Warning header explaining what was dropped.

Authentication​

API key issued for your Application, sent in the X-API-Key header.

Security Scheme Type:

apiKey

Header parameter name:

X-API-Key