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

المصادقة

تستخدم واجهات Itqan مفتاح API للتعرّف على تطبيقك. نقاط القراءة العامة تعمل حاليًا دون مفتاح، لكننا ننصح بإنشاء مفتاح الآن — فهو يفتح الميزات المعتمدة على الحساب، وحدود استخدام أعلى، ويُبقي تكاملك جاهزًا مع توسّع المصادقة.

احصل على مفتاح API

  1. سجّل الدخول إلى مكتبة الأصول على cms.itqan.dev.
  2. افتح إعدادات حسابك وانتقل إلى مفاتيح API.
  3. أنشئ مفتاحًا، وأعطه اسمًا وصفيًا (مثل my-recitation-app)، وانسخه.

خزّنه بأمان. تعامل مع المفتاح كأنه كلمة مرور — احفظه في متغيّر بيئة أو مدير أسرار، ولا تضعه أبدًا في نظام التحكم بالمصادر أو في كود يعمل على جهة العميل.

أرسل المفتاح

مرّر مفتاحك في كل طلب عبر ترويسة X-API-Key:

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

الأخطاء

المفتاح المفقود أو غير الصالح يعيد خطأً بـصيغة الأخطاء الموحدة:

الحالةالمعنىالحل
401 Unauthorizedالمفتاح مفقود أو بصيغة خاطئةأضف ترويسة X-API-Key صالحة
403 Forbiddenالمفتاح صالح لكنه غير مسموح لهذا الموردراجع صلاحيات المفتاح في مكتبة الأصول

تستمر التكاملات الحالية مع نقاط القراءة العامة في العمل دون انقطاع أثناء التطبيق التدريجي لاشتراط المفتاح.


انظر أيضاً: البداية السريعة · معالجة الأخطاء