الأدلة

البدء السريع

أنشئ مفاتيح API قياسية واحكم عليها وضع ضوابط حمايتها باستخدام مفتاح إدارة RunAPI.

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

إنشاء مفتاح إدارة

اتبع دليل المصادقة لتسجيل الدخول، ثم افتح صفحة Management Keys وأنشئ مفتاح إدارة. احتفظ به بمعزل عن مفاتيح التطبيقات القياسية. أرسله كرمز bearer إلى نقاط نهاية Platform Management فقط.

HTTP

Authorization: Bearer YOUR_MANAGEMENT_KEY

لا يمكن لمفتاح API القياسي استدعاء نقاط نهاية إدارة المفاتيح أو الحراس. قد يتلقى مفتاح الإدارة الصالح استجابة 403 Forbidden حين لا يمتلك مالكه دور الحساب المطلوب بعد الآن.

سرد مفاتيح API القياسية

استخدم GET /api/v1/keys للاطلاع على المفاتيح المرئية لحساب مفتاح الإدارة:

SHELL

curl "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY"

استخدم المعرّفات العامة المُعادة لطلبات الاسترجاع أو التحديث أو الإلغاء أو تعيين الحواجز لاحقًا. لا تستنتج صلاحية الوصول من اسم المفتاح أو الرمز المخفي.

إنشاء مفتاح وتدويره

أنشئ مفتاح تطبيق باستخدام POST /api/v1/keys. يُعاد السرّ الكامل في استجابة الإنشاء فحسب، لذا احفظه في مدير الأسرار قبل تجاهل تلك الاستجابة. يجب أن يُنشئ التدوير مفتاحاً بديلاً، وينشره في التطبيق، ويتحقق من حركة المرور، ثم يُلغي المفتاح القديم.

SHELL

curl -X POST "https://runapi.ai/api/v1/keys" \
  -H "Authorization: Bearer YOUR_MANAGEMENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Production worker"}'

credit_limit_windows يقبل أي مجموعة من حدود الإنفاق المتجددة 1h و1d و7d. إذا استُنفدت أي نافذة مُهيَّأة، تُعيد الاستدعاءات ذات المفتاح المعني 429 Too Many Requests حتى يخرج الاستخدام من تلك النافذة. أرسل كائنًا فارغًا عند تحديث مفتاح لمسح جميع الحدود المتجددة.

تطبيق الحراس

Guardrails هي سياسات حساب قابلة لإعادة الاستخدام لضبط النموذج والمزود والإنفاق. أدر السياسات عبر /api/v1/guardrails، ثم استخدم /api/v1/guardrail_assignments لإرفاقها أو إزالتها. عامل التخصيص المرفوض باعتباره إخفاقاً في السياسة أو الملكية بدلاً من الاستمرار بصمت دون guardrail.

معالجة أخطاء الإدارة

401 Unauthorized تعني أن بيانات الاعتماد مفقودة أو مشوّهة أو ملغاة أو غير صالحة.
403 Forbidden تعني أن فئة بيانات الاعتماد أو دور الحساب لا يمكنه تنفيذ هذه العملية.
404 Not Found تعني أن المورد المطلوب غير مرئي للحساب المُصادَق عليه.
422 Unprocessable Content تعني أن قيمة واحدة أو أكثر من القيم المُرسَلة تنتهك قاعدة موارد.