تتم المصادقة على واجهة برمجة تطبيقات Nateq باستخدام مفاتيح API التي يتم
تمريرها كرمز Bearer:
Authorization: Bearer tg_live_your_key_here
البيئات
| البادئة | البيئة | ملاحظات |
|---|
tg_live_ | الإنتاج | يعمل على البيانات الحقيقية |
tg_test_ | بيئة الاختبار | بيئة اختبار معزولة |
النطاقات
تُمنح المفاتيح نطاقات تتحكم في ما يمكنها فعله. الطلب إلى نقطة نهاية يفتقر
مفتاحها إلى نطاقها يُرجع 403 INSUFFICIENT_SCOPE. امنح المفتاح الحد الأدنى مما
يحتاجه فقط.
| النطاق | يمنح |
|---|
conversations:read / conversations:write | المحادثات والرسائل والفئات وإدارة علاقات العملاء (جهات الاتصال، الشركات، العملاء المحتملون) |
tickets:read / tickets:write | تذاكر الدعم والردود |
tags:read / tags:write | الوسوم |
teams:read | الفِرَق |
templates:read / templates:write | قوالب الرسائل والسمات |
broadcasts:read / broadcasts:write | البثوث |
faqs:read / faqs:write | الأسئلة الشائعة ومحتوى مركز المساعدة |
files:read / files:write | مرفقات الملفات |
overview_stats:read | التحليلات والإحصائيات |
webhooks:manage | اشتراكات الـ webhooks الصادرة |
لا يمكن الوصول إلى نقاط نهاية الحساب والفوترة وإدارة المستخدمين والـ RBAC
ومُنشئ الذكاء الاصطناعي باستخدام مفتاح API على الإطلاق — استدعاء أي منها يُرجع
403 ENDPOINT_NOT_PUBLIC. استخدم لوحة التحكم لهذه الأغراض.
الحفاظ على أمان المفاتيح
تعامل مع المفاتيح ككلمات المرور. لا تقم أبداً بإيداعها في نظام التحكم بالإصدارات
أو كشفها في كود من جانب العميل — فالواجهة مُصمّمة للاستدعاء من الخادم الخاص بك.
- قيّد المفتاح إلى عناوين IP معروفة (قائمة سماح) حيثما أمكن.
- قم بتدوير المفاتيح بشكل دوري؛ وألغِ أي مفتاح مسرّب من لوحة التحكم.
- استخدم مفتاح بيئة الاختبار (
tg_test_) للتطوير.
