Pular para o conteúdo principal

​
Introdução

A API REST do WhataBot permite que você gerencie programaticamente sessões de conversa, fluxos, espaços de trabalho, setores e clientes OAuth. Todos os endpoints v1 são acessíveis através de requisições HTTP padrão que retornam respostas JSON.

​
URL Base

Todas as requisições da API v1 são feitas para: 
https://api.whatabot.app/api/v1

​
Formato de Resposta

Todas as respostas são retornadas como JSON. Respostas bem-sucedidas usam códigos de status HTTP padrão (200, 201, 202, 204). Respostas de erro seguem o formato: 
{
  "statusCode": 400,
  "message": "Validation failed",
  "error": "Bad Request"
}

​
Paginação

Endpoints de listagem suportam paginação via parâmetros de consulta:
ParâmetroTipoPadrãoDescrição
pageinteger0Número da página (base 0)
sizeinteger20Itens por página
sortstring-Ordenação no formato campo,direção (ex: createdAt,desc)
Respostas paginadas incluem: 
{
  "content": [...],
  "pageable": {
    "pageNumber": 0,
    "pageSize": 20,
    "sort": {
      "sorted": true,
      "unsorted": false,
      "empty": false
    },
    "offset": 0,
    "paged": true,
    "unpaged": false
  },
  "totalElements": 42,
  "totalPages": 3,
  "size": 20,
  "number": 0,
  "sort": {
    "sorted": true,
    "unsorted": false,
    "empty": false
  },
  "first": true,
  "last": false,
  "numberOfElements": 20,
  "empty": false
}

​
Autenticação

Todos os endpoints v1 usam autenticação por Chave de API via cabeçalho X-Api-Key: 
curl -X GET "https://api.whatabot.app/api/v1/flows" \
  -H "X-Api-Key: wh_your_api_key_here"
Consulte a página de Autenticação para instruções de como criar sua chave de API.

​
Referência Rápida

Autenticação

Chaves de API e autenticação para iframe.

Webhooks

Receba notificações de sessões via callback.

Sessões

Crie e gerencie sessões de conversa.

Fluxos

Crie e liste fluxos de conversa.

Espaços de Trabalho

Gerencie espaços de trabalho.

Setores

Gerencie setores para transferências.