API ציבורית ותיעוד

התחברו למערכות שלכם ל‑Whatsplaid באמצעות API, מחברים ו‑webhook.

השתמש ב־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

שולח הודעת טקست בתוך חלון התמיכה של 24 השעות של WhatsApp.

Messaging

POST /handoffs

בקש תמיכה אנושית באמצעות תצורת החברה הנוכחית.

Handoff

חוזים טכניים

התיעוד מכסה את ה-API, את המחבר החיצוני ואת ה-webhooks.

תפריט האינטגרציות של ADMIN משתמש באותה חלוקה: Whatsplaid Public API, מחבר חיצוני לשאילתות במערכות פנימיות ו-webhook יוצא ל-leads שנתפסו.

API pública

מאמת חשבון, מודולים, אנשי קשר, תגים, שדות מותאמים אישית, הודעות, שיחות, עגלה ותמיכה אנושית.

מחבר חיצוני

המערכת שלכם חושפת נקודות קצה כגון `/products/search` ו־`/orders/search` כדי ש‑Whatsplaid יוכל לשאול אותן במהלך השיחה.

מוצרים

החזרת נתונים צפויה עם `products`, הכוללת ID, שם, תיאור, מחיר, זמינות, מלאי, URL ותמונה.

הזמנות

תשובה צפויה עם `orders`, הכוללת מספר, סטטוס, תשלום, משלוח, סך, לקוח, מעקב ופריטים.

Webhookים

האירוע `LEAD_CAPTURE` שולח נתוני ליד לכתובת ה‑URL המוגדרת. נקודת הקצה חייבת להחזיר HTTP 200 או 204.

אבטחה

השתמש ב־`Authorization: Bearer` בקריאות. אסור להציג טוקנים בחזית ציבורית.

בעזרתכם להטמיע או לאמת אינטגרציה?

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

פתח Swagger