مصادقة طلب API

إرسال ترويسة مفتاح API

تُقدَّم واجهة API البرمجية العامة من https://api.threetone.in. أرسل المفتاح في ترويسة الطلب x-api-key:

curl --request GET \
  --url 'https://api.threetone.in/v1/convai/agents' \
  --header "x-api-key: $THREETONE_API_KEY"

استخدم المفتاح قيمةً للترويسة. لا تضعه في عنوان URL أو سلسلة الاستعلام أو متن الطلب. يجب أن يرسل الطلب البرمجي x-api-key؛ ويُرفض إرساله مع ترويسة Authorization لأنه يجعل بيانات الاعتماد ملتبسة.

إبقاء المفتاح على الخادم

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

تسجيل معرّف الطلب

يرسل Threetone ترويسة الاستجابة X-Request-Id. احتفظ بقيمتها مع وقت الطلب وطريقته ومساره وحالته عند حل المشكلات. يمكنك أيضًا إرسال X-Request-Id صالح من عندك؛ وستعيده واجهة API في الاستجابة.