Ваша система вызывает Whatsplaid для проверки учетной записи, управления контактами, тегами, полями, разговорами, корзиной, сообщениями и человеческим обслуживанием.
Публичный API и документация
Подключайте собственные системы к Whatsplaid с помощью API, коннекторов и вебхуков.
Используйте публичный API, когда другая система должна активировать Whatsplaid. Используйте внешний коннектор, когда ассистент должен запрашивать продукты, заказы или данные вашей системы во время разговора. Используйте вебхуки для получения событий, зафиксированных в WhatsApp.
Три контракта
Выберите правильное направление интеграции.
Документация Swagger разделяет потоки, чтобы избежать путаницы между вызовами к Whatsplaid, запросами ассистента и событиями, отправляемыми в вашу систему.
Whatsplaid вызывает вашу систему для запроса продуктов, заказов, клиентов или доступности в реальном времени во время разговора.
Whatsplaid отправляет события на ваш URL. Доступное событие на панели — это лид, захваченный во время разговора.
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, внешний коннектор и вебхуки.
Меню интеграций в ADMIN использует ту же сегментацию: публичный API Whatsplaid, внешний коннектор для запросов в собственных системах и исходящий вебхук для захваченных лидов.
Проверяет аккаунт, модули, контакты, теги, пользовательские поля, сообщения, беседы, корзину и человеческое обслуживание.
Ваша система отображает конечные точки как `/products/search` и `/orders/search`, чтобы Whatsplaid мог их запрашивать во время разговора.
Ожидаемый ответ с `products`, включая ID, название, описание, цену, доступность, наличие на складе, URL и изображение.
Ожидаемый ответ с `orders`, включая номер, статус, оплату, доставку, итоги, клиента, трекинг и позиции.
Событие `LEAD_CAPTURE` отправляет данные лида на настроенный URL. Конечная точка должна отвечать HTTP 200 или 204.
Используйте `Authorization: Bearer` в вызовах. Токены не должны быть раскрыты на публичном фронтенде.
Нужно реализовать или проверить интеграцию?
Откройте интерактивную документацию для переключения между `Whatsplaid Public API`, `Custom Data Connector Contract` и `Outgoing Webhooks`.