الانتقال إلى المحتوى الرئيسي
تقريباً كل ميزات Gorbit متاحة من خلال Gorbit API. واجهات برمجة تطبيقات Gorbit مبنية على مبادئ REST مع تنسيق طلب/استجابة JSON. جميع نقاط النهاية تتطلب المصادقة وتتبع أنماطاً متسقة نسبياً. قم بإجراء طلبات API إلى: https://cloud.gorbit.app/api أو https://your-self-hosted-gorbit.com/api
يتبع Gorbit SemVer 2.0.0. سيتم الإشارة إلى التغييرات الجذرية من خلال زيادة رقم النسخة الرئيسية.

​
المصادقة

​
مفاتيح API

يتم إنشاء مفاتيح API من قبل المسؤولين من لوحة الإدارة. كل مفتاح موجود كمستخدم مميز في Gorbit، مما يعني أنه يمكنك تتبع النشاط، والحفاظ على خصوصية جلسات المحادثة، وتحديد نطاق الموارد لمفتاح معين. هناك ثلاثة أنواع:
يمكنها الوصول إلى جميع نقاط النهاية، بما في ذلك تلك المسبوقة بـ admin/.حالات الاستخدام:
  • إدارة النظام الكاملة
  • عمليات إدارة المستخدمين
  • إدارة البيانات والتحليلات
  • الوصول الكامل لجميع ميزات Gorbit
⚠️ استخدم بحذر: مفاتيح المسؤول لديها وصول غير مقيد لمثيل Gorbit الخاص بك.
يمكنها الوصول إلى نقاط النهاية غير الإدارية مثل البحث، المحادثة، الوكلاء، والإجراءات.حالات الاستخدام:
  • بناء تطبيقات المحادثة
  • تنفيذ وظائف البحث
  • إنشاء وإدارة الوكلاء
  • تشغيل الإجراءات وسير العمل
✅ موصى بها: يجب على معظم المستخدمين استخدام مفاتيح API الأساسية لتطوير التطبيقات.
وصول للوكلاء للقراءة فقط. يمكنها نشر رسائل إلى نقاط نهاية المحادثة، لكن لا يمكنها قراءة سجل المحادثة.حالات الاستخدام:
  • البيئات المقيدة للغاية
  • حالات الاستخدام المحددة التي تتطلب أذونات محدودة
  • الاختبار مع نطاق محدود
راجع مفاتيح API للحصول على تعليمات الإعداد.

​
رموز الوصول الشخصية

تتيح رموز الوصول الشخصية (PATs) لأي مستخدم المصادقة على طلبات API كمستخدم نفسه. على عكس مفاتيح API، ترث PATs دورك وأذوناتك الخاصة، لذا يمكنها الوصول إلى ما يمكنك الوصول إليه بالضبط. لإنشاء رمز، انتقل إلى الإعدادات > الحسابات والوصول وانقر على إنشاء رمز جديد. أعطه اسماً واختر انتهاء الصلاحية (7 أيام، 30 يوماً، 365 يوماً، أو أبداً).
يتم عرض الرمز مرة واحدة فقط عند الإنشاء. انسخه فوراً واحفظه بأمان.
استخدم الرمز كرمز Bearer في ترويسة Authorization: 
curl -H "Authorization: Bearer gorbit_pat_..." \
  https://cloud.gorbit.app/api/chat/get-user-chat-sessions
يمكنك عرض وتدقيق وإلغاء رموزك في أي وقت من الإعدادات > الحسابات والوصول.

​
مرجع API وساحة التجربة

في مرجع API، قمنا بتنظيم مجموعة فرعية من نقاط نهاية Gorbit API المفيدة. يمكنك تجربة نقاط النهاية في كل صفحة أو اتباع أحد الأدلة. يمكنك العثور على جميع نقاط نهاية Gorbit API في مستكشف OpenAPI المدمج: https://cloud.gorbit.app/api/docs أو https://your-gorbit-domain.com/api/docs
المستكشف للمرجعية فقط. ليس عميل API كامل الميزات. تجاهل معامل tenant_id واستخدم مفتاح API كرمز Bearer.

​
الخطوات التالية

المفاهيم الأساسية

تعلم المفاهيم والمصطلحات الأساسية للعمل مع Gorbit APIs

دليل: إرسال رسالة محادثة

مثال بسيط على إرسال رسالة برمجياً