مرجع API للمطورين
اربط تطبيقك بمساحة عملك: REST API ومفاتيحه ونطاقاته والأخطاء وحدود المعدل وWebhooks.
أين تجده
⚙️ الإعدادات › مرجع API · الصفحة الرئيسية › الموارد › مرجع API
فتح هذه الشاشة
الخطوات
- افتح “مرجع API” من الشريط الجانبي، أو “مرجع API” في قائمة “الموارد” بالصفحة الرئيسية.
- ابدأ من “ابدأ من هنا”: “عنوان URL الأساسي والاصطلاحات” و“المصادقة” و“النطاقات”.
- ابحث في “نقاط النهاية” حسب المجموعة؛ تعرض كل واحدة معاملاتها وجسم الطلب والاستجابة والأخطاء مع أمثلة.
- اقرأ “الأخطاء ورموز الحالة” و“حدود المعدل” و“Webhooks (الصادرة)” قبل الإطلاق. “OpenAPI JSON” ينزّل المواصفات كاملة.
استكشاف الأخطاء وإصلاحها
كيف أحصل على مفتاح API؟
تُصدر المفاتيح لمساحة عملك عند الطلب؛ ولا يمكن إنشاؤها في التطبيق بعد. تُدرج مفاتيح مساحة عملك في صفحة المطورين في قسم الذكاء الاصطناعي، حيث يستطيع القائمون على إدارة مساحة العمل أيضًا إضافة نقاط نهاية Webhook واختبارها.
نصائح
- استدعِ API من خادمك فقط. لا تضع مفتاحًا في صفحة ويب أو تطبيق جوال.
جدير بالمعرفة
- مرجع API مقروء دون تسجيل الدخول.
أدلة استخدام ذات صلة
- كيف أجد نقطة نهاية وأنسخ مثالًا؟ ابحث في مرجع API، وانتقل إلى نقطة نهاية، وانسخ مثالها أو رابطها.
- كيف أقرأ الأسئلة الشائعة (المستندات)؟ اقرأ إجابات قصيرة عما يفعله المنتج اليوم: البدء واللغات والأصوات والمكالمات التجريبية وأرقام الهاتف والخطط والحساب.
- الإمكانات الكتالوج الكامل لإمكانات مركز الاتصال، وكل منها موسوم بصدق على أنه تم إطلاقه أو مخطط له.