API والتكاملات

تتيح API & Integrations لأنظمتك الخاصة التواصل مع Midlr: موقعك الإلكتروني، أو متجرك الإلكتروني، أو نظام ERP، أو نظام CRM. مثلاً، يمكن لموقعك إنشاء عميل محتمل عندما يملأ شخص نموذجاً، أو يمكن لمتجرك إرسال تحديث للطلب عبر واتساب عند شحنه.

هذه الصفحة موجهة أساساً لمطوّرك أو شريكك التقني. بصفتك صاحب النشاط التجاري، مهمتك هي إنشاء الرمز (Token) وتسليمه بأمان.

قبل أن تبدأ

• تُفعَّل API & Integrations لكل نشاط تجاري على حدة، وهي متاحة في خطط محددة. إذا لم تجدها ضمن الإعدادات والدعم، فتواصل مع الدعم.
• تحتاج إلى صلاحية عرض التكاملات. ولإنشاء الرمز أو استبداله تحتاج إلى صلاحية إدارة التكاملات. راجع الأدوار والصلاحيات.

فتح API والتكاملات

في الشريط الجانبي، افتح الإعدادات والدعم وانقر API & Integrations.

تتكون الصفحة من جزأين:

• إعداد المصادقة: رمز API الخاص بنشاطك التجاري.
• واجهات برمجة التطبيقات المتاحة للربط: القائمة الكاملة لما يمكن لأنظمتك فعله، مع وثائق لكل منها.

إنشاء رمز API

تُثبت أنظمتك أنها تابعة لنشاطك التجاري بإرسال هذا الرمز مع كل طلب.

1. ضمن إعداد المصادقة، انقر توليد رمز API.
2. انسخ الرمز فوراً وسلّمه إلى مطوّرك عبر قناة آمنة (وليس في محادثة جماعية أو سلسلة رسائل بريد إلكتروني عامة).

تتغير حالة الرمز من غير مهيأ إلى نشط.

تحذير

يظهر الرمز مرة واحدة فقط. إذا فقدته، سيكون عليك إنشاء رمز جديد. أي شخص لديه الرمز يستطيع قراءة الرسائل وإرسالها باسم نشاطك التجاري، لذا تعامل معه ككلمة مرور.

إذا كان بإمكانك عرض الصفحة دون إنشاء رمز، تظهر لك رسالة اطلب من المسؤول تزويدك بالرمز.

استبدال الرمز

إذا كان الرمز قد تسرّب، أو غادر أحد المطوّرين:

1. انقر تجديد رمز API.
2. انقر نعم، قم بالتجديد.
3. سلّم الرمز الجديد إلى مطوّرك.

تحذير

يتوقف الرمز القديم عن العمل فوراً. أي نظام لا يزال يستخدمه سيفشل حتى يتم تحديثه بالرمز الجديد.

ما يمكن لأنظمتك فعله

قائمة واجهات برمجة التطبيقات المتاحة للربط مجمّعة حسب الموضوع. استخدم ابحث في واجهات API بالاسم أو المسار أو الطريقة أو المجموعة... للعثور على واجهة، وعرض الوثائق لرؤية تفاصيلها وأمثلتها.

المجموعة	الغرض منها
العملاء المحتملون	إنشاء العملاء المحتملين وعرض قائمتهم وعرضهم وتحديثهم وحذفهم.
القوالب	عرض قائمة قوالب الرسائل الخاصة بك وعرضها، وإرسال قوالب جديدة.
Messages	إرسال رسائل واتساب: نص، وقوالب، وصور، وفيديو، ومستندات، وصوت، وأزرار، ورسائل منتجات، وبطاقات دوّارة، ونماذج، وروابط كتالوج، وتفاعلات، ومؤشر الكتابة.
Chat Conversations	عرض قائمة المحادثات، وقراءة الرسائل، وتمييزها كمقروءة، وأرشفتها وإلغاء أرشفتها.
Client Numbers	عرض قائمة جهات الاتصال وعرضها، وحظرها أو إلغاء حظرها، وإيقاف البوت مؤقتاً أو استئنافه لجهة اتصال واحدة.
Labels	عرض قائمة التصنيفات وإنشاؤها وحذفها، ووضع التصنيفات على جهات الاتصال.
Orders وCart	عرض قائمة الطلبات وإنشاؤها، وتغيير حالتها أو عناصرها، وإدارة سلة العميل حتى إتمام الشراء.
Catalog Products	عرض قائمة المنتجات في الكتالوج والبحث فيها.
Bookings	عرض قائمة الحجوزات، والتحقق من التوفر، وإنشاء الحجوزات، وتغيير حالتها، وعرض قائمة الخدمات والموظفين. راجع الحجوزات.
Flows	عرض قائمة النماذج وعرضها وتحديثها.
Business Numbers	عرض قائمة أرقام الأعمال المتصلة وعرضها.
SMS	إرسال رسالة نصية (SMS) والتحقق من حالتها. راجع الرسائل النصية.
Logs	الاطلاع على سجل استدعاءات API التي أجرتها أنظمتك.
Webhooks	يشرح توجيه الأحداث: إرسال Midlr كل رسالة واتساب واردة إلى نظامك. يمكنك إعداده في إعداد الأعمال.

مجموعتان لا تعملان إلا إذا كانت الميزة المقابلة متاحة لنشاطك التجاري:

• Bookings تعمل فقط في خطة Premium. في الخطط الأخرى، تُرفض الطلبات مع رسالة تفيد بأن خطتك لا تتضمنها.
• SMS تعمل فقط إذا كانت الرسائل النصية مفعّلة لنشاطك التجاري. تحتاج أيضاً إلى قالب SMS معتمد، ومرسل معتمد، ورصيد كافٍ في محفظة SMS، تماماً كما في حملات الرسائل النصية. راجع الرسائل النصية.

تسليم الوثائق إلى مطوّرك

• تعرض وثائق كل واجهة API الترويسات (headers)، والمعاملات (parameters)، ومثال على حمولة JSON، ومثال على الاستجابة، واستجابات الحالة الممكنة. كل طلب يرسل رمزك في الترويسة x-business-token.
• انقر تصدير الكل إلى Postman لتنزيل كل واجهات API كمجموعة Postman، أو تصدير إلى Postman لواجهة واحدة. Postman أداة مجانية يستخدمها المطوّرون لتجربة واجهات API.

نصيحة

إرسال الرسائل عبر API يخضع لقواعد واتساب نفسها التي تنطبق على الإرسال من Midlr. خارج نافذة الـ 24 ساعة لا يمكنك إرسال إلا القوالب المعتمدة.

مواضيع ذات صلة

• إعداد الأعمال: توجيه الأحداث
• القوالب