مرجع API والـ Webhooks
واجهة REST API للتحكم البرمجي بزملاء الذكاء الاصطناعي والمحادثات وجهات الاتصال والتكاملات. مصادقة JWT عبر AWS Cognito.
نظرة عامة
يوفر Teammates.ai واجهة REST API للوصول البرمجي إلى زملاء الذكاء الاصطناعي والمحادثات وجهات الاتصال والتكاملات. تستخدم الواجهة مصادقة JWT عبر AWS Cognito. جميع نقاط النهاية تعيد استجابات JSON وتتبع اصطلاحات REST.
المصادقة
جميع طلبات API تتطلب رمز JWT. احصل على الرموز من خلال مسار تسجيل الدخول القياسي. تتجدد الرموز تلقائيًا عند استخدام SDK الخاص بلوحة التحكم. للاستدعاءات المباشرة لـ API، أضف الرمز في ترويسة Authorization. عنوان URL الأساسي هو عنوان لوحة التحكم الخاصة بمنظمتك متبوعًا بـ /api/v1/.
- 1
احصل على رمز JWT
سجّل الدخول من خلال مسار تسجيل الدخول في لوحة التحكم. يتم إرجاع رمز JWT عند المصادقة الناجحة عبر AWS Cognito.
- 2
أضف ترويسة Authorization
أضف الترويسة إلى كل طلب API: Authorization: Bearer {your_jwt_token}
- 3
تعامل مع تجديد الرمز
تنتهي صلاحية الرموز بشكل دوري. استخدم مسار رمز التجديد في Cognito للحصول على رمز وصول جديد بدون إعادة المصادقة. يتولى SDK لوحة التحكم هذا تلقائيًا.
الـ Webhooks
يرسل ويستقبل Teammates.ai webhooks لمزامنة البيانات في الوقت الفعلي. تستقبل webhooks الواردة أحداثًا من Freshdesk وZendesk وIntercom (أحداث التذاكر) وHubSpot (أحداث CRM). ترسل webhooks الصادرة إشعارات إلى Slack وMicrosoft Teams. يتم التحقق من جميع webhooks الواردة بشكل آمن لمنع الوصول غير المصرح به، ويمنع نظام إلغاء التكرار المدمج المعالجة المزدوجة للأحداث.
مهم
تحقق دائمًا من توقيعات webhook الواردة قبل المعالجة. ارفض أي طلب يفشل في التحقق من HMAC. المفتاح السري الخاص بمنظمتك متاح في إعدادات المنظمة > API.
نقاط نهاية API الرئيسية
فيما يلي نظرة عامة على فئات API المتاحة. للاطلاع على توثيق نقاط النهاية الكامل بما في ذلك مخططات الطلب والاستجابة، تواصل مع support@teammates.ai.
| الفئة | نقاط النهاية | الوصف |
|---|---|---|
| الوكلاء | /api/v1/agents/ | عمليات CRUD على زملاء الذكاء الاصطناعي |
| المحادثات | /api/v1/chat/ | جلسات المحادثة، سجل الرسائل |
| المقابلات | /api/v1/interviews/ | جدولة المقابلات، التقييم |
| الحملات | /api/v1/campaigns/ | إدارة حملات المبيعات |
| CRM | /api/v1/crm/ | مركز تكامل CRM، حالة المزامنة |
| التكاملات | /api/v1/integrations/ | استدعاءات OAuth، حالة الاتصال |
| الـ Webhooks | /api/v1/webhooks/ | معالجات webhook الواردة |
حدود المعدل
طلبات API محدودة المعدل لكل منظمة لضمان استقرار المنصة. تنطبق حدود المعدل القياسية على جميع الخطط. إذا كنت تحتاج إلى معدل أعلى لتكاملات عالية الحجم، تواصل مع support@teammates.ai لمناقشة تعديلات حدود المعدل في خطة Enterprise.
الأسئلة الشائعة
هل يمكنني بناء تكاملات مخصصة؟
هل يوجد مجموعة Postman؟
هل استدعاءات API تستهلك أرصدة؟
مقالات ذات صلة
جاهز لتجربة التكاملات؟
ابدأ مجانًا — لا تحتاج بطاقة ائتمان.