Skip to main content
يتم تقديم الواجهة البرمجية العامة ضمن /v1 على أصل لوحة تحكم Failproof AI الخاصة بك.

​
إنشاء مفتاح وتقديم طلب

  1. افتح Administration → Keys، اختر Create key، واختر أضيق إعداد إذن يغطي التكامل.
  2. أضف منح فردية فقط عند الحاجة، أنشئ المفتاح، وانسخ سره لمرة واحدة.
  3. قدّم طلب اختبار إلى /v1/sessions وأكد أن المفتاح يبقى نشطًا في صفحة Keys.
  4. قم بتدوير المفتاح أو تعطيله من قائمة الإجراءات الخاصة به عند تغيير ملكية التكامل. درج مفتاح API الجديد مع إعدادات الأذونات والمنح الفردية.
يظهر درج الإنشاء أعلاه. يظهر السر لمرة واحدة فقط بعد أن تختار create؛ انسخه قبل إغلاق هذا التأكيد.
المفاتيح مقتصرة على مجموعة منظمة وإذن. يُرجع الطلب الذي لا يملك الإذن المطلوب لنقطة النهاية 403 ويحدد الإذن المفقود.

​
اختيار المنظمة

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