المصادقة
تستخدم واجهات Itqan مفتاح API للتعرّف على تطبيقك. نقاط القراءة العامة تعمل حاليًا دون مفتاح، لكننا ننصح بإنشاء مفتاح الآن — فهو يفتح الميزات المعتمدة على الحساب، وحدود استخدام أعلى، ويُبقي تكاملك جاهزًا مع توسّع المصادقة.
احصل على مفتاح API
- سجّل الدخول إلى مكتبة الأصول على cms.itqan.dev.
- افتح إعدادات حسابك وانتقل إلى مفاتيح API.
- أنشئ مفتاحًا، وأعطه اسمًا وصفيًا (مثل
my-recitation-app)، وانسخه.
خزّنه بأمان. تعامل مع المفتاح كأنه كلمة مرور — احفظه في متغيّر بيئة أو مدير أسرار، ولا تضعه أبدًا في نظام التحكم بالمصادر أو في كود يعمل على جهة العميل.
أرسل المفتاح
مرّر مفتاحك في كل طلب عبر ترويسة X-API-Key:
- curl
- Python
- JavaScript
curl https://staging.api.cms.itqan.dev/reciters/ \
-H "X-API-Key: YOUR_API_KEY"
import urllib.request
import json
req = urllib.request.Request(
"https://staging.api.cms.itqan.dev/reciters/",
headers={"X-API-Key": "YOUR_API_KEY"},
)
with urllib.request.urlopen(req) as resp:
data = json.load(resp)
print(f"إجمالي القراء: {data['count']}")
const resp = await fetch("https://staging.api.cms.itqan.dev/reciters/", {
headers: { "X-API-Key": "YOUR_API_KEY" },
});
const { count, results } = await resp.json();
console.log(`إجمالي القراء: ${count}`);
الأخطاء
المفتاح المفقود أو غير الصالح يعيد خطأً بـصيغة الأخطاء الموحدة:
| الحالة | المعنى | الحل |
|---|---|---|
401 Unauthorized | المفتاح مفقود أو بصيغة خاطئة | أضف ترويسة X-API-Key صالحة |
403 Forbidden | المفتاح صالح لكنه غير مسموح لهذا المورد | راجع صلاحيات المفتاح في مكتبة الأصول |
تستمر التكاملات الحالية مع نقاط القراءة العامة في العمل دون انقطاع أثناء التطبيق التدريجي لاشتراط المفتاح.
انظر أيضاً: البداية السريعة · معالجة الأخطاء