Skip to main content
تستخدم معظم واجهات برمجة تطبيقات Plato مفاتيح API التي تم إنشاؤها في وحدة التحكم. إنشاء مفاتيح من مفاتيح وحدة التحكم API. استخدم مفتاحًا مخصصًا لكل تكامل حتى يمكن تدويره أو إزالته دون التأثير على الأدوات الأخرى.

​
رأس مفضل

بالنسبة لمعظم طلبات API، أرسل المفتاح كرمز مميز لحامله:
مثال:

​
رأس بديل

تستخدم بعض عمليات التكامل x-api-key:
مثال:

​
معلمة الاستعلام

تقبل نقاط نهاية REST الأقدم أيضًا apiKey في سلسلة الاستعلام:
استخدم الرؤوس لعمليات التكامل الجديدة من جانب الخادم. يمكن أن تظهر سلاسل الاستعلام في السجلات وسجل المتصفح وأدوات التحليلات وعناوين URL المشتركة. احتفظ بـ PLATO_API_KEY على الخادم. لا تعرضه في متصفح JavaScript أو تطبيقات الهاتف المحمول.

​
مصادقة الجلسة

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

​
السلامة الرئيسية

  • قم بتخزين مفاتيح API في متغيرات البيئة أو مدير سري.
  • لا تلصق المفاتيح في التعليمات البرمجية العامة أو لقطات الشاشة أو تذاكر الدعم أو المستندات.
  • قم بتدوير المفاتيح عندما يتغير مالك الأداة.
  • حذف المفاتيح التي لم تعد مستخدمة.
  • امنح كل مفتاح الدور الأصغر الذي يسمح للتكامل بالعمل.