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

المصادقة

تستخدم Alkax بيانات اعتماد مختلفة للأشخاص الذين يستخدمون التطبيق وللمشاريع التي تتكامل من خادم. استخدم أضيق بيانات اعتماد ونطاقات تناسب سير العمل.

جلسات المستخدم​

تستخدم إجراءات المستخدم التفاعلية رمز وصول حاملًا:

Authorization: Bearer <access-token>

يمكن إصدار الرموز بعد تسجيل الدخول بإحدى الطرق المدعومة، مثل كلمة المرور أو مفتاح المرور أو موفّر هوية مفعّل. جلسات المستخدم مخصصة للإجراءات المنفذة نيابة عنه.

لا تنسخ رمز مستخدم إلى تكامل خادم طويل التشغيل.

بيانات اعتماد منصة المطورين​

تقبل نقاط نهاية الاتصال بين الخوادم بيانات اعتماد مشروع:

X-Alkax-Key: ak_test_<key-id>.<secret>

لكل مشروع بيئتا اختبار Sandbox وإنتاج Production منفصلتان:

  • تبدأ مفاتيح Sandbox بـ ak_test_.
  • تبدأ مفاتيح Production بـ ak_live_.

يمكن للخطة المجانية إصدار بيانات اعتماد Sandbox واستخدامها. ويلزم اشتراك مدفوع لإصدار بيانات اعتماد Production أو تدويرها أو استخدامها. يُجمع الاستخدام الشهري لواجهة API عبر جميع المشاريع والبيئات المفوترة لمالك الاشتراك.

يُعرض السر الكامل عند إصدار بيانات الاعتماد أو تدويرها فقط. احفظه فورًا في مدير أسرار. تحتفظ Alkax بمعرّف المفتاح وتجزئة مشتقة من السر، لا بالسر الأصلي.

النطاقات الأولية المتاحة هي:

  • places:read
  • geocode:read
  • delivery:read
  • delivery:write

أصدر بيانات اعتماد منفصلة لكل خدمة وبيئة. ينشئ التدوير بديلًا يمكنك نشره قبل إلغاء بيانات الاعتماد السابقة. يؤدي الإلغاء أو انتهاء الصلاحية أو تعليق المشروع أو البيئة إلى رفض الطلبات اللاحقة.

راجع دليل منصة المطورين لإعداد المشاريع وبيانات Sandbox الثابتة والسجلات والحصص وخطافات الويب.

سلامة بيانات الاعتماد​

  • لا تضمّن بيانات اعتماد المشروع في JavaScript للواجهة الأمامية أو ملف تطبيق الهاتف التنفيذي.
  • لا تضع بيانات اعتماد أو رابط مستلم أو سر توقيع خطاف ويب في عنوان URL.
  • احجب الأسرار وبيانات التوصيل الخاصة من السجلات وآثار التتبّع.
  • تعامل مع 401 باعتباره بيانات اعتماد مفقودة أو غير سليمة التنسيق أو غير صالحة أو منتهية الصلاحية أو ملغاة. وتعامل مع 403 باعتباره طلبًا تمت مصادقته دون إذن لتنفيذ العملية.
  • ألغِ بيانات الاعتماد فورًا إذا احتمل انكشافها.
  • أرفق X-Request-Id من الاستجابة عند التواصل مع الدعم؛ ولا ترسل بيانات الاعتماد نفسها.

يحدّد مرجع API آلية المصادقة لكل نقطة نهاية مدعومة.