تصفّح الأقسام
رمز الوصول وعنوان الـ API
اعرف رمز الوصول الخاص بك ومعرّف مساحة العمل والعنوان الأساسي قبل أول طلب إلى الـ API.
في هذا المقال
تتيح واجهة حاضر شات البرمجية (API) لأنظمتك أن تقرأ بيانات مساحة عملك وتعدّلها: جهات الاتصال والمحادثات والرسائل وغيرها. كل طلب يحتاج ثلاثة أشياء: العنوان الأساسي، ومعرّف مساحة العمل، ورمز الوصول.
العنوان الأساسي
كل طلبات الـ API تُرسل إلى:
https://app.hadir.chat/api/v1/accounts/{account_id}/…الطلبات والردود بصيغة JSON. أرسل الترويسة Content-Type: application/json مع كل طلب فيه محتوى.
اعرف معرّف مساحة العمل
- افتح صندوق الوارد في المتصفح.
- انظر إلى شريط العنوان. الجزء الذي بعد
/app/accounts/هو معرّف مساحة عملك، مثلacc_7Hk2mPq9RtWx. - ضعه مكان
{account_id}.
الـ API يقبل هذا المعرّف (يبدأ بـ acc_). الأنظمة القديمة التي تستخدم الرقم التسلسلي لمساحة العمل تبقى تعمل، لكن استخدم معرّف acc_ في أي ربط جديد، لأنه المعرّف الذي تعرضه لوحة التحكم.
انسخ رمز الوصول
- اضغط صورتك في أسفل القائمة الجانبية، ثم إعدادات الملف الشخصي.
- انزل إلى قسم رمز المصادقة (1).
- اضغط نسخ (2) واحفظ الرمز في مكان آمن على خادمك، مثل متغيّر بيئة.
أرسل الرمز مع كل طلب
ضع الرمز في ترويسة اسمها api_access_token:
curl https://app.hadir.chat/api/v1/accounts/acc_7Hk2mPq9RtWx/inboxes \
-H "api_access_token: YOUR_ACCESS_TOKEN"إن كان الرمز صحيحاً تصلك قائمة قنواتك. وإن لم يكن، يصلك الرد 401 ومعه {"error": "Invalid Access Token"}.
ماذا يستطيع الرمز؟
- الرمز لك أنت، لا لمساحة العمل. كل طلب يعمل باسمك وبصلاحيات دورك. رمز الموظف لا يستطيع ما يختص به المدير، مثل إضافة الموظفين أو الفرق أو الـ Webhooks.
- إن كنت عضواً في أكثر من مساحة عمل، يعمل الرمز نفسه في كل منها حسب المعرّف الذي في الرابط.
- إن كانت باقتك لا تشمل الـ API، يصلك الرد
402ومعه"error_code": "feature_not_in_plan".
غيّر الرمز
إن شككت أن الرمز تسرّب، اضغط إعادة تعيين بجانبه، ثم اضغطه مرة ثانية للتأكيد. يصدر رمز جديد ويتوقف القديم فوراً، فحدّث كل نظام يستخدمه.
ملاحظة: من يملك رمزك يستطيع أن يتصرّف باسمك في مساحة عملك. لا تضعه في صفحة ويب ولا في تطبيق جوال ولا في مستودع كود عام، وأبقه على خادمك فقط.
التالي: مرجع الـ API والـ Webhooks.
شكراً لملاحظتك ✓
وصلتنا ملاحظتك، وسنراجع المقال على ضوئها.