/v1 على أصل لوحة تحكم Failproof AI الخاصة بك.
إنشاء مفتاح وإجراء طلب
- Dashboard
- CLI
- افتح Administration → Keys، وحدد Create key، واختر أضيق مجموعة أذونات تغطي التكامل.
- أضف المنح الفردية فقط عند الحاجة، وأنشئ المفتاح، وانسخ سره لمرة واحدة.
-
أجرِ طلب اختبار إلى
/v1/sessionsوتأكد من بقاء المفتاح نشطًا في صفحة Keys. -
قم بتدوير أو تعطيل المفتاح من قائمة الإجراءات الخاصة به عند تغيير ملكية التكامل.
403 ويحدد الإذن المفقود.
اختيار المنظمة
يعمل مفتاح المنظمة على منظمته تلقائيًا. يمكن لمفتاح محدود النطاق على المثيل تحديد منظمة لكل طلب:- Dashboard
- CLI
استخدم مبدل المنظمة في رأس لوحة التحكم قبل فتح Administration → Keys. تنتمي المفاتيح المُنشأة هناك إلى المنظمة المحددة. أكّد على slug المنظمة في عنوان URL وتفاصيل المفتاح قبل نسخ بيانات الاعتماد إلى الأتمتة.
/v1.
تحتوي المواصفات الحالية على تغطية كاملة للمسار والطريقة والمعامل والإذن وأكواد الحالة. تبقى بعض أجسام الاستجابة غير مكتوبة بقصد لأن الخادم لا يزال ينشئها كـ JSON ديناميكي. افحص رد فعل حقيقي قبل إنشاء عميل مكتوب بقوة حول نقطة نهائية بدون مخطط استجابة.
استخدم Content-Type: application/json لعمليات كتابة JSON. تعامل مع 401 كمصادقة مفقودة أو غير صالحة، و403 كهوية صالحة بدون الإذن المطلوب، و404 كمورد مفقود أو غير قابل للوصول للمنظمة، و409 كتضارب في الحالة، و422 كقيمة حقل أو إذن غير صالحة. تتضمن استجابات الخطأ رسالة قابلة للقراءة من قبل الإنسان؛ تسمي أيضًا فشل الأذونات المنحة المطلوبة.