تتطلب جميع طلبات API المصادقة باستخدام مفتاح API. تشرح هذه الدليل كيفية إنشاء وإدارة واستخدام مفاتيح API بشكل آمن.
للحصول على مفتاح API، تحتاج إلى أن يكون لديك حساب iloveQR وأن تكون جزءًا من منظمة.
تسجيل الدخول أو إنشاء حساب إذا لم يكن لديك واحد.
اذهب إلى لوحة التحكم → المطورين لإدارة مفاتيح API الخاصة بك.
انقر على 'إنشاء مفتاح API'، أعطه اسمًا وصفيًا، واحفظ المفتاح الذي تم إنشاؤه بشكل آمن.
قم بتضمين مفتاح API الخاص بك في رأس X-API-Key مع كل طلب:
curl -X GET \
https://api.iloveqr.com/api/v1/organizations/YOUR_ORG_ID/qr-codes \
-H "X-API-Key: ilqr_your_api_key_here" \
-H "Content-Type: application/json"تتطلب معظم نقاط نهاية API معرف منظمة في مسار URL. يمكنك العثور على معرف المنظمة الخاص بك في إعدادات لوحة التحكم أو من خلال إجراء طلب إلى نقطة نهاية المنظمات.
curl -X GET \
https://api.iloveqr.com/api/v1/users/me/organizations \
-H "X-API-Key: ilqr_your_api_key_here"{
"organizations": [
{
"id": "org_abc123",
"name": "My Company",
"slug": "my-company",
"role": "ADMIN"
}
]
}قم دائمًا بإجراء مكالمات API من خادمك. لا تتضمن مفاتيح API في JavaScript التي تعمل في المتصفح أو التطبيقات المحمولة أو أي كود يمكن أن يراه المستخدمون.
قم بتخزين مفاتيح API الخاصة بك في متغيرات البيئة، وليس في قاعدة التعليمات البرمجية الخاصة بك. هذا يمنع التعرض العرضي من خلال التحكم في الإصدارات.
قم بإنشاء مفاتيح API جديدة بشكل دوري وألغِ القديمة. إذا كنت تشك في أن مفتاحًا قد تم اختراقه، قم بإلغائه على الفور.
عندما تفشل المصادقة، تعيد API واحدة من استجابات الخطأ هذه:
| رمز الحالة | خطأ | وصف |
|---|---|---|
401 | UNAUTHORIZED | مفتاح API مفقود أو غير صالح |
403 | FORBIDDEN | مفتاح API ليس لديه إذن لهذا الإجراء |
403 | API_KEY_REVOKED | تم إلغاء مفتاح API |
{
"statusCode": 401,
"message": "Invalid or missing API key",
"error": "Unauthorized"
}الآن بعد أن فهمت المصادقة، تعلم كيفية استخدام API: