REST API

التعليمات أدناه مخصصة لأجهزة الكمبيوتر المكتبية والمحمولة فقط.

تتيح لك واجهة برمجة التطبيقات REST API الخاصة بـ tawk.to أتمتة وإدارة العديد من جوانب حسابك، مما يسهل إنجاز المهام ويتيح دمج tawk.to مع أنظمتك الحالية.


يمكنك استخدام REST API من أجل:


  • إنشاء خصائص ودعوة أعضاء الفريق تلقائيًا


  • استرجاع قوائم مفلترة من التذاكر أو الدردشات أو أعضاء الخاصية


  • عرض إحصاءات الدردشة حسب الوكيل أو الوسم أو القسم أو التاريخ


  • إدارة الـ webhooks


  • إنشاء مقالات في قاعدة المعرفة وعرضها


  • إنشاء وتخصيص واجهات الدردشة


ملاحظة: تم تصميم REST API للمطورين أو أي شخص مرتاح للعمل مع الأكواد. إذا كنت جديدًا على واجهات برمجة التطبيقات (APIs)، ففكر في العمل مع مطور.


للمرجع التقني وآخر التحديثات، قم بزيارة بوابة مطوري tawk.to.


للتعرف أكثر على استخدام الـ webhooks، اطلع على هذا الدليل:

إنشاء وإدارة Webhooks

أولاً، اطلب الوصول إلى REST API

واجهة REST API متاحة عند الطلب. للبدء:


1. قم بملء نموذج طلب الوصول إلى REST API


2. بمجرد الموافقة على طلبك، ستتلقى اسم مستخدم وكلمة مرور ورابطًا إلى توثيق REST API.

إنشاء مفتاح API

بعد أن تحصل على وصول REST API:


1. سجّل الدخول إلى حسابك في tawk.to.

2. انقر على صورة ملفك الشخصي في الزاوية السفلية اليسرى من لوحة التحكم.

3. انقر على تعديل (Edit) الملف الشخصي.

4. انقر على REST API Keys في القائمة اليسرى.

5. انقر على Create Key.

6. سيظهر مفتاحك الجديد في القائمة.

مهم: احتفظ بمفتاح API الخاص بك في مكان آمن. لا تشاركه مع جهات غير مصرح لها.

لحذف مفتاح، حدد المفتاح ثم انقر على حذف.

مصادقة طلباتك

جميع طلبات REST API يجب أن:


  • تستخدم HTTPS


  • تستخدم مصادقة HTTP Basic مع مفتاح API كاسم مستخدم في ترويسة Authorization


يعتمد إعداد ذلك على عميل HTTP أو لغة البرمجة التي تستخدمها. معظمها يدعم مصادقة Basic بشكل مدمج.


تعرّف أكثر على ترويسة تفويض HTTP هنا.

الرابط الأساسي (Base URL) وأسلوب الطريقة

الرابط الأساسي: https://api.tawk.to/v1/


تستخدم REST API طرقًا بأسلوب RPC عبر HTTP. مرّر المعلمات في جسم طلبات POST إلا إذا تم ذكر غير ذلك في التوثيق.

مثال على طلب

الحصول على تفاصيل الوكيل الحالي



  • المصادقة: HTTP Basic (مفتاح API كاسم مستخدم)


  • الاستجابة: JSON مع مؤشر نجاح؛ الأخطاء تتضمن رمز خطأ قصير.

التعامل مع الاستجابات والأخطاء
  • تعيد الطلبات الناجحة JSON مع مؤشر نجاح واضح.


  • إذا حدث خطأ، ستتضمن الاستجابة رمز خطأ يمكنك استخدامه لتصحيح أو معالجة المشكلة.


اطّلع على توثيق REST API للحصول على القائمة الكاملة للطرق والمعلمات ورموز الأخطاء.


اطرح أسئلتك على مجتمع المطورين لدينا إذا كانت لديك استفسارات حول استخدام REST API.

اعتبارات هامة
  • الأمان

قم بتخزين مفاتيح API الخاصة بك بشكل آمن وقم بتدويرها بانتظام.


  • الاختبار

جرّب طلباتك في بيئة تجريبية قبل إجراء أي تغييرات في بيئة الإنتاج.


  • معالجة الأخطاء

خطط لإعادة المحاولة مع فترات انتظار متزايدة في حال حدوث مشاكل مؤقتة.


  • الخطافات (Webhooks)

قم بالتحقق من البيانات الواردة للتأكد من أن الطلبات أصلية.


  • بدائل

إذا كنت بحاجة فقط لتخصيص الواجهة على موقعك، فقد يكون JavaScript API أبسط من REST API.


إذا كان لديك ملاحظات حول هذه المقالة، أو إذا كنت بحاجة إلى مزيد من المساعدة:


هل كان هذا المقال مفيداً؟

78 من 113 أعجب بهذا المقال