مفاتيح API

تمنح مفاتيح API النصوص البرمجية والتكاملات وصولًا برمجيًا طويل الأمد إلى REST API دون الحاجة إلى جلسة متصفح.

إصدار مفتاح

يمكنك إنشاء مفتاح بطريقتين:

• في التطبيق، من الإعدادات ← مفاتيح API.
• عبر API، باستخدام POST /api/v1/keys مع name:

curl -X POST https://<your-host>/api/v1/keys \
  -H "Authorization: Bearer <session-token>" \
  -H "Content-Type: application/json" \
  -d '{ "name": "ci-export-bot" }'

تحتوي الاستجابة على المفتاح الكامل، الذي يبدأ بـ ef_live_.

warning

تُعرَض قيمة المفتاح (ef_live_...) مرة واحدة فقط. يخزّن EntityFlow تجزئة (hash) لها فقط — ولا يمكن استرجاعها مرة أخرى أبدًا. انسخها فورًا واحتفظ بها في مكان آمن.

استخدام مفتاح

أرسله كرمز حامل (bearer token) في أي طلب REST:

curl https://<your-host>/api/v1/diagrams \
  -H "Authorization: Bearer ef_live_xxxxxxxxxxxxxxxx"

السرد والإبطال

يمكنك سرد المفاتيح وإبطالها في أي وقت، من الإعدادات ← مفاتيح API أو عبر نقاط النهاية /api/v1/keys. يسري إبطال المفتاح على الفور.

الأذونات

يتطلّب إصدار المفاتيح وإبطالها إذن account:manage. يرث المفتاح الأذونات المقيّدة بنطاق المستأجر (tenant) الخاصة بالحساب الذي يملكه.