API العامة والوثائق

قم بربط أنظمتك الخاصة بـ Whatsplaid باستخدام API، الموصلات و webhooks.

استخدم API العامة عندما يحتاج نظام آخر إلى تفعيل Whatsplaid. استخدم الموصل الخارجي عندما يحتاج المساعد إلى استعلام المنتجات، الطلبات أو بيانات نظامك أثناء المحادثة. استخدم webhooks لتلقي الأحداث الملتقطة على WhatsApp.

فتح التوثيق عرض التكاملات

Base URL https://api.whatsplaid.com/v1

# autenticação
Authorization: Bearer {"{api_token}"}

# validar conta, módulos e integrações
GET /store

# enviar mensagem dentro da janela do WhatsApp
POST /messages/send
{
  "phone": "5511999999999",
  "text": "Seu atendimento foi atualizado."
}

ثلاث عقود

اختر الاتجاه الصحيح للتكامل.

توثق Swagger التدفقات لتجنب الالتباس بين المكالمات إلى Whatsplaid، الاستعلامات التي يجريها المساعد والأحداث المرسلة إلى نظامك.

01 Public API

نظامك يستدعي Whatsplaid للتحقق من الحساب، إدارة جهات الاتصال، العلامات، الحقول، المحادثات، السلة، الرسائل والدعم البشري.

02 Custom Data Connector

يستدعي Whatsplaid نظامك للاستعلام عن المنتجات، الطلبات، العملاء أو التوفر في الوقت الحقيقي أثناء المحادثة.

03 Outgoing Webhooks

يرسل Whatsplaid أحداثًا إلى عنوان URL الخاص بك. الحدث المتاح على اللوحة هو العميل المحتجز خلال المحادثة.

04 توثيق

يحتوي Swagger في `api.whatsplaid.com/docs/` على المخططات، الأمثلة، الردود المتوقعة والعقود الفنية الكاملة.

مرجع سريع لأهم نقاط النهاية.

تلخص هذه النظرة الموارد التي تظهر في التوثيق الرسمي. يجب أن يتبع التنفيذ النهائي Swagger.

GET /store

يعيد بيانات الحساب، والتجارة الإلكترونية المتصلة والوحدات النشطة.

Account

GET /modules

قائمة الوحدات النشطة، مثل العملاء المحتجزين، مستشار المبيعات، ما بعد البيع، قاعدة المعرفة وعربة التسوق.

Account

GET /ecommerce/products/search

يبحث عن المنتجات في التكاملات الأصلية المتصلة، مثل Nuvemshop، Wix أو Shopify.

Ecommerce

GET /ecommerce/orders/search

يبحث عن الطلبات بواسطة الرقم، البريد الإلكتروني أو الهاتف في التكاملات الأصلية المتصلة.

Ecommerce

POST /contacts

ينشئ أو يحدث جهة اتصال باستخدام الهاتف كمفتاح رئيسي.

Contacts

PATCH /contacts/{contactId}/custom-fields

يحدث الحقول المخصصة للتقسيم والسياق التشغيلي.

Fields

POST /messages/send

يرسل رسالة نصية داخل نافذة خدمة WhatsApp خلال 24 ساعة.

Messaging

POST /handoffs

يطالب بخدمة بشرية باستخدام إعدادات الشركة الحالية.

Handoff

العقود الفنية

يغطي التوثيق API، الموصل الخارجي و webhooks.

يستخدم قائمة التكاملات في ADMIN نفس الفصل: API العامة لـ Whatsplaid، الموصل الخارجي للاستعلامات في الأنظمة الخاصة و webhook الصادر للعملاء المحتجزين.

API pública

يحقق من الحساب، الوحدات، جهات الاتصال، العلامات، الحقول المخصصة، الرسائل، المحادثات، عربة التسوق وخدمة العملاء البشرية.

موصل خارجي

يعرض نظامك نقاط النهاية مثل `/products/search` و `/orders/search` ليتم استعلامها بواسطة Whatsplaid خلال المحادثة.

المنتجات

الرد المتوقع مع `products`، بما في ذلك المعرف، الاسم، الوصف، السعر، التوفر، المخزون، URL والصورة.

الطلبات

الرد المتوقع مع `orders`، بما في ذلك الرقم، الحالة، الدفع، التسليم، الإجمالي، العميل، التتبع والعناصر.

Webhooks

يرسل الحدث `LEAD_CAPTURE` بيانات العميل المحتجز إلى عنوان URL المكون. يجب أن يرد نقطة النهاية بـ HTTP 200 أو 204.

الأمان

استخدم `Authorization: Bearer` في الطلبات. يجب عدم كشف الرموز المميزة في الواجهة الأمامية العامة.

هل تحتاج إلى تنفيذ أو التحقق من تكامل؟

افتح التوثيق التفاعلي للتبديل بين `Whatsplaid Public API`، `Custom Data Connector Contract` و `Outgoing Webhooks`.

فتح Swagger