مفاتيح API والنطاقات
يمنح مفتاح API نصًا برمجيًا أو خدمة وصولًا إلى مساحة عملك دون تسجيل دخول شخص. تحمل المفاتيح نطاقات، فيمكن حصر المفتاح فيما تتطلبه مهمته.
إنشاء مفتاح
- سجّل الدخول كمسؤول وافتح API Keys.
- سمِّ المفتاح، واختر نطاقاته، وإن أردت مدة انتهاء بالأيام.
- انسخ المفتاح عند ظهوره. يبدأ بـ
xcrt_ولا يمكن عرضه مرة أخرى.
لا يستطيع إنشاء مفتاح أو إبطاله إلا مسؤول مسجّل الدخول، ولا يمكن منح المفتاح إلا نطاقات يملكها منشئه. يحصل المفتاح الجديد على certs:read ما لم تختر غيره.
استخدام مفتاح
curl -H "Authorization: Bearer xcrt_your_key" \
https://api.automate-certificates.com/v1/certificatesالنطاقات
| النطاق | يتيح |
|---|---|
certs:read | سرد الشهادات وتحدياتها وقراءتها. |
certs:write | طلب الشهادات وتجديدها واستيرادها وإبطالها وحذفها. |
targets:read | سرد الأهداف وقراءتها. |
targets:write | إنشاء الأهداف وتغييرها وحذفها. |
deploy:read | قراءة عمليات النشر. |
deploy:execute | تشغيل عمليات النشر وإدارة قواعدها. |
monitoring:read | قراءة نتائج المراقبة. |
alerts:read | قراءة التنبيهات. |
alerts:write | ضبط قواعد التنبيه وإدارة webhooks. |
audit:read | قراءة سجل التدقيق. |
ما لا يستطيعه المفتاح المحدد النطاق
تتطلب إدارة الأعضاء والأدوار ومفاتيح API وحسابات ACME وبيانات اعتماد السحابة مسؤولًا مسجّل الدخول أو مفتاحًا كامل الصلاحيات. يُرفض المفتاح المحدد النطاق برمز 403 insufficient_scope، حتى لو كان مالكه مسؤولًا. تقبل بعض إجراءات المسؤول، مثل تشغيل فحص اكتشاف أو تجديد جماعي، مفتاحًا يحمل النطاق المناسب ويعود لمسؤول.
الحدود
تتيح كل خطة عددًا ثابتًا من المفاتيح. تُحدَّد الطلبات بـ 120 في الدقيقة لكل مساحة عمل.