Ваша система обращается к Whatsplaid для проверки учётных записей, управления контактами, тегами, полями, переписками, корзиной, сообщениями и поддержкой людьми.
Публичный API и документация
Подключите ваши системы к Whatsplaid через API, коннекторы и вебхуки.
Используйте публичный API, когда другой системе нужно инициировать работу Whatsplaid. Используйте внешний коннектор, когда ассистенту во время беседы требуется запрашивать товары, заказы или данные из вашей системы. Используйте вебхуки для получения событий, зафиксированных в WhatsApp.
Три контракта
Выберите правильное направление интеграции.
Документация Swagger разделяет потоки, чтобы избежать путаницы между вызовами в Whatsplaid, запросами, выполняемыми ассистентом, и событиями, отправляемыми в вашу систему.
Whatsplaid обращается к вашей системе, чтобы запрашивать информацию о товарах, заказах, клиентах или доступности в реальном времени во время разговора.
Whatsplaid отправляет события на указанный вами URL. Событие, отображаемое в панели, — это лид, зафиксированный во время разговора.
Swagger на `api.whatsplaid.com/docs/` содержит схемы, примеры, ожидаемые ответы и полные технические контракты.
Краткая справка по основным конечным точкам.
Этот вид суммирует функции, которые представлены в официальной документации. Финальная реализация должна соответствовать Swagger.
GET
/store
Возвращает данные аккаунта, подключённый e‑commerce и активные модули.
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 использует такое же разделение: Whatsplaid Public API, внешний коннектор для запросов в собственные системы и исходящий webhook для захваченных лидов.
Проверяет аккаунт, модули, контакты, теги, пользовательские поля, сообщения, беседы, корзину и поддержку человека.
Ваша система предоставляет конечные точки, такие как `/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`.