وثائق واجهة برمجة التطبيقات
المصادقة

مصادقة واجهة برمجة التطبيقات

تتطلب جميع طلبات واجهة برمجة التطبيقات (API) مصادقة باستخدام مفتاح API. تشرح هذه الدليل كيفية إنشاء وإدارة واستخدام مفاتيح API بشكل آمن.

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

للحصول على مفتاح API، تحتاج إلى أن يكون لديك حساب iloveQR وأن تكون جزءًا من منظمة.

1

تسجيل الدخول إلى حسابك

تسجيل الدخول أو إنشاء حساب إذا لم يكن لديك واحد.

2

انتقل إلى صفحة المطورين

اذهب إلى لوحة التحكم → المطورين لإدارة مفاتيح API الخاصة بك.

3

إنشاء مفتاح 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 جديدة بشكل دوري وقم بإلغاء المفاتيح القديمة. إذا كنت تشك في أن مفتاحًا ما قد تم اختراقه، قم بإلغائه على الفور.

أخطاء المصادقة

عندما تفشل المصادقة، ترجع واجهة برمجة التطبيقات واحدة من هذه الاستجابات الخطأ:

رمز الحالةخطأوصف
401
UNAUTHORIZEDمفتاح API مفقود أو غير صالح
403
FORBIDDENمفتاح API ليس لديه إذن لهذا الإجراء
403
API_KEY_REVOKEDتم إلغاء مفتاح واجهة برمجة التطبيقات
مثال على استجابة الخطأ
{
  "statusCode": 401,
  "message": "Invalid or missing API key",
  "error": "Unauthorized"
}

الخطوات التالية

الآن بعد أن فهمت المصادقة، تعلم كيفية استخدام واجهة برمجة التطبيقات: