API publiczne i dokumentacja

Połącz własne systemy z Whatsplaid za pomocą API, konektorów i webhooków.

Użyj API publicznego, gdy inny system musi wywołać Whatsplaid. Użyj zewnętrznego konektora, gdy asystent musi sprawdzić produkty, zamówienia lub dane z Twojego systemu podczas rozmowy. Użyj webhooków, aby otrzymywać zdarzenia zarejestrowane na WhatsApp.

Otwórz dokumentację Zobacz integracje

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."
}

Trzy umowy

Wybierz właściwy kierunek integracji.

Dokumentacja Swagger oddziela przepływy, aby uniknąć pomyłek między wywołaniami do Whatsplaid, zapytaniami od asystenta i zdarzeniami wysyłanymi do Twojego systemu.

01 Public API

Twój system wywołuje Whatsplaid, aby zweryfikować konto, zarządzać kontaktami, tagami, polami, rozmowami, koszykiem, wiadomościami i obsługą ludzką.

02 Custom Data Connector

Whatsplaid wywołuje Twój system, aby sprawdzić produkty, zamówienia, klientów lub dostępność w czasie rzeczywistym podczas rozmowy.

03 Outgoing Webhooks

Whatsplaid wysyła zdarzenia do Twojego URL. Zdarzenie dostępne na panelu to lead zarejestrowany podczas rozmowy.

04 Dokumentacja

Swagger w `api.whatsplaid.com/docs/` zawiera schematy, przykłady, oczekiwane odpowiedzi i pełne umowy techniczne.

Szybka referencja głównych punktów końcowych.

Ten widok podsumowuje zasoby, które pojawiają się w oficjalnej dokumentacji. Ostateczna implementacja powinna podążać za Swaggerem.

GET /store

Zwraca dane konta, połączony e-commerce i aktywne moduły.

Account

GET /modules

Lista de módulos ativos, como leads, consultor de vendas, pós-venda, base de conhecimento e carrinho.

Account

GET /ecommerce/products/search

Busca produtos nas integrações nativas conectadas, como Nuvemshop, Wix ou Shopify.

Ecommerce

GET /ecommerce/orders/search

Busca pedidos por número, e-mail ou telefone nas integrações nativas conectadas.

Ecommerce

POST /contacts

Cria ou atualiza contato usando telefone como chave principal.

Contacts

PATCH /contacts/{contactId}/custom-fields

Atualiza campos personalizados para segmentação e contexto operacional.

Fields

POST /messages/send

Envia mensagem de texto dentro da janela de atendimento de 24 horas do WhatsApp.

Messaging

POST /handoffs

Solicita atendimento humano usando a configuração atual da empresa.

Handoff

Contratos técnicos

A documentação cobre API, conector externo e webhooks.

O menu de integrações do ADMIN usa a mesma separação: API pública do Whatsplaid, conector externo para consultas em sistemas próprios e webhook de saída para leads capturados.

API pública

Valida conta, módulos, contatos, tags, campos personalizados, mensagens, conversas, carrinho e atendimento humano.

Zewnętrzny Konwerter

Seu sistema expõe endpoints como `/products/search` e `/orders/search` para o Whatsplaid consultar durante a conversa.

Produkty

Retorno esperado com `products`, incluindo ID, nome, descrição, preço, disponibilidade, estoque, URL e imagem.

Zamówienia

Retorno esperado com `orders`, incluindo número, status, pagamento, entrega, total, cliente, rastreio e itens.

Webhooks

O evento `LEAD_CAPTURE` envia dados do lead para a URL configurada. O endpoint deve responder HTTP 200 ou 204.

Segurança

Use `Authorization: Bearer` nas chamadas. Tokens não devem ser expostos no frontend público.

Precisa implementar ou validar uma integração?

Abra a documentação interativa para alternar entre `Whatsplaid Public API`, `Custom Data Connector Contract` e `Outgoing Webhooks`.

Abrir Swagger