إنشاء مفتاح
- افتح الإعدادات ثم مفاتيح API، واختر إنشاء مفتاح.
- سمّه باسم النظام الذي سيستخدمه. اختر نطاق صلاحيات وتاريخ انتهاء اختياريًا.
- انسخ المفتاح الآن واحفظه في مخزن أسرار نظامك.
Important: يُعرَض المفتاح الكامل مرة واحدة. إذا فقدته، فأبطله وأنشئ غيره.
| النطاق | يعمل بدور |
|---|---|
| قراءة فقط | مشاهد. يمكنه قراءة ما يقرؤه المشاهد. |
| قراءة وكتابة | مدير كحد أقصى. يمكنه إنشاء ما ينشئه المدير وتغييره. |
استخدامها
أرسل المفتاح في ترويسة Authorization لكل طلب إلى API التطبيق:
Authorization: Bearer ehk_...
- يعمل المفتاح لمؤسسته فقط وضمن نطاق صلاحياته فقط.
- لا تلزم ترويسة CSRF عند استخدام مفتاح.
- لا يستطيع المفتاح إنشاء مفاتيح أخرى أو إدارتها.
- تُسجَّل الطلبات المقدمة بمفتاح في سجل التدقيق باسم مفتاح API.
الإبطال
اختر إبطال على المفتاح فيتوقف فورًا، وتتلقى الأنظمة المستخدمة له أخطاء 401. يتوقف المفتاح أيضًا عند مغادرة العضو الذي أنشأه المؤسسة. تعرض القائمة آخر استخدام لكل مفتاح.
Tip: امنح كل عملية ربط مفتاح قراءة خاصًا بها حيثما أمكن. إذا تسرّب أحدها، تبطل ذلك المفتاح وحده.
للحصول على وصف API لمطوريك، اطلبه عبر نموذج التواصل.