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

إعداد المصادقة لإجراءات واجهة برمجة التطبيقات REST

آخر تحديث كان منذ أكثر من 3 أسبوع

ملخص

يشرح هذا المقال كيفية تكوين المصادقة لعمليات API REST في Astra. يتناول الأساليب المدعومة للمصادقة، متى استخدام كل منها، وكيفية إعدادها بشكل صحيح حتى يتم قبول طلبات API الخاصة بك.

الإرشادات

تخبر المصادقة نظامًا خارجيًا بأن الطلب القادم من Astra مسموح به. عند وضع إعدادات عمل API REST، يمكنك اختيار واحد من الأساليب المدعومة للمصادقة بناءً على ما يتطلبُه API الخاص بك.

يدعم Astra حاليًا الخيارات التالية للمصادقة:

  • مصادقة المفتاح API

  • المصادقة الأساسية

  • لا توجد مصادقة

مصادقة المفتاح API

هذه هي أسلوب المصادقة الأكثر شيوعًا المستخدم من قبل واجهات برمجة التطبيقات الحديثة.

باستخدام مصادقة المفتاح API، ترسل مفتاحًا أو رمزًا في رؤوس الطلب.

ما الذي تحتاج إلى تقديمه

  • auth_key: اسم رأس HTTP (على سبيل المثال، Authorization أو X-API-Key)

  • auth_value: القيمة المرسلة في الرأس (على سبيل المثال، Bearer your-token)

الأنماط الشائعة

نوع الخدمة

اسم الرأس

تنسيق قيمة الرأس

معظم واجهات برمجة التطبيقات

Authorization

Bearer your-token

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

X-API-Key

your-api-key

خدمات الويب هوك

X-Webhook-Secret

your-secret

تأكد من تطابق اسم الرأس وقيمته تمامًا مع ما يتوقعه توثيق API الخاص بك.

المصادقة الأساسية

تُستخدم عادةً المصادقة الأساسية من قبل الأنظمة القديمة أو الأنظمة الوراثية. بهذه الطريقة:

  • تقدم اسم مستخدم وكلمة مرور

  • ترسل Astra هذه الاعتمادات باستخدام المصادقة الأساسية القياسية لبروتوكول HTTP

لا توجد مصادقة

لا تتطلب بعض نقاط نهاية الويب العامة أي مصادقة.

نصائح لإعداد ناجح

  • أكد على أسلوب المصادقة المطلوب في توثيق API الخاص بك

  • تحقق مرتين من أسماء الرؤوس والقيم وتنسيقات الرموز

  • اجرب عمل API REST بعد الحفظ للتأكد من عمل المصادقة

يضمن اختيار أسلوب المصادقة الصحيح تشغيل أعمال API REST الخاصة بك بشكل سلس وأمن.

المقالات ذات الصلة
كيفية إعداد إجراء واجهة برمجة التطبيقات REST
هل أجاب هذا عن سؤالك؟