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/` מכיל את הסכימות, דוגמאות, תגובות צפויות והסכמים טכניים מלאים.

הפניה מהירה לנקודות הקצה המרכזיות.

ההצגה מק summarizes את המשאבים שמופיעים בתיעוד הרשמי. היישום הסופי צריך לעקוב אחר 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 שהוגדר. ה-endpoint צריך להגיב ב-HTTP 200 או 204.

אבטחה

השתמש ב-`Authorization: Bearer` בשיחות. אסור לחשוף טוקנים בחזית הפומבית.

צריך ליישם או לאמת אינטגרציה?

פתח את התיעוד האינטראקטיבי כדי להחליף בין `Whatsplaid Public API`, `Custom Data Connector Contract` ו-Webhooks יוצאים.

פתח Swagger