للمطورين

API التكامل

للمطورين: ما يستطيع برنامجك فعله برمز الاتصال، وأين تجد العقد الكامل.

يتيح API التكامل لبرنامجك، أو لتطبيق آخر مثل Max، أن يعمل مع Chaos عبر اتصال. لكل اتصال رمزه وصلاحياته وقائمة عناصره.

ما يستطيع فعله

• عرض النماذج والاختبارات التي يصل إليها الاتصال، بعناوينها وحالتها، وقراءة أسئلتها.
• إنشاء المسودات وتحديثها. أنت تراجعها وتنشرها في Chaos.
• قراءة ملخصات تحفظ الخصوصية: أعداد فقط، مخفية حتى يجيب 5 أشخاص على الأقل.
• إنشاء webhooks خاصة به وإدارتها، ولا تتضمن الإجابات أبدًا.

ما لا يستطيع فعله

• نشر أي شيء أو إغلاقه أو حذفه.
• قراءة الردود الفردية أو نص الإجابات أو الأسماء أو البريد أو الملفات.
• إضافة أسئلة رفع ملفات أو منطق أو ترجمات أو خواتيم. تحديث المسودة يُبقي ما فيها منها.

استدعاء الـ API

• أنشئ اتصالًا من الاتصالات وانسخ رمزه. تعرض الصفحة عنوان الـ API الذي تستدعيه.
• أرسل الرمز بصيغة Authorization: Bearer <token> في كل طلب. المحتوى بصيغة JSON.
• الطلبات التي تغيّر شيئًا تحتاج إلى ترويسة Idempotency-Key، كي لا تُنشئ إعادة المحاولة مسودة ثانية.
• لكل اتصال حد للطلبات في الدقيقة. وتخبرك ترويسات الرد بالمتبقي.

العقد الكامل، بكل نقطة وصول ورمز خطأ وقاعدة إصدارات، في وثيقة API التكامل، الإصدار 1 (بالإنجليزية).