Visão geral da API
O que a API pública do SunchatPlus faz, onde ela responde e como as respostas são organizadas.
O que a API pública do SunchatPlus faz, onde ela responde e como as respostas são organizadas.
A API pública do SunchatPlus é uma API REST que abre os dados da sua conta para outros sistemas. Com ela você cadastra contatos vindos do seu site, dispara mensagens de WhatsApp pelo ERP, move negócios no funil quando um pedido é faturado ou espelha os tickets em um painel próprio.
Esta seção é técnica. Ela parte do princípio de que alguém vai escrever código. Se você quer usar a plataforma pela tela, comece pelo Guia da plataforma.
Todas as chamadas partem de um único endereço:
https://api-publica.sunchat.com.br
Os caminhos vêm depois dele, sempre com o prefixo da versão:
https://api-publica.sunchat.com.br/v1/contatodechat.
Guarde a base em variável de ambiente ou arquivo de configuração, nunca espalhada pelo código, para que qualquer troca futura seja uma linha só. Mudança de endereço sai antes no Changelog da API.
A versão atual é a v1 e ela aparece no caminho de todo endpoint. Mudança que
quebra contrato entra em uma versão nova. Dentro da v1 só entram adições
compatíveis, como um campo novo em uma resposta.
Isso tem três consequências na hora de consumir a API:
O formato é JSON nos dois sentidos, com Content-Type: application/json.
Nas respostas, os nomes dos campos usam PascalCase:
{
"Id": "8f14e45f-ea6d-4a1c-9c1f-3b7d2a5e9c04",
"Nome": "Maria Souza",
"Ativo": true
}
Nas requisições, o nome do campo é lido sem diferenciar maiúsculas de minúsculas.
Tanto {"nome": "Maria"} como {"Nome": "Maria"} funcionam. Escolha uma das
duas formas e use sempre a mesma, para o seu código não ficar misturado.
| Tipo | Formato | Exemplo |
|---|---|---|
| Identificador | GUID em texto | "8f14e45f-ea6d-4a1c-9c1f-3b7d2a5e9c04" |
| Data e hora | ISO 8601 | "2026-08-18T14:30:00" |
| Valor monetário | número, ponto como separador decimal | 199.9 |
| Booleano | true ou false, sem aspas | true |
| Enumeração | número inteiro | 1 |
O significado de cada número das enumerações está em Enumerações.
São 212 endpoints em 28 recursos. Cada endpoint tem a sua própria página nesta mesma aba, com parâmetros, corpo, respostas e um playground para testar na hora. A página Recursos funciona como índice: ela mostra o que cada grupo cobre e leva direto ao endpoint.
A maioria dos recursos segue o mesmo desenho:
| Verbo | Caminho | O que faz |
|---|---|---|
GET | /v1/recurso | Lista com paginação, filtros e ordenação |
GET | /v1/recurso/{id} | Obtém um registro pelo ID |
POST | /v1/recurso | Cria |
PUT | /v1/recurso/{id} | Substitui o registro inteiro |
PATCH | /v1/recurso/{id} | Altera só os campos enviados |
DELETE | /v1/recurso/{id} | Exclui |
PUT substitui, então campo omitido é apagado. PATCH existe em produtos e
tickets e altera apenas o que você enviar. Canais, usuários e vendas são somente
leitura, porque esses registros nascem na plataforma.
Os dois cabeçalhos que toda requisição precisa e como gerar sua chave.
Do zero até criar um contato e enviar uma mensagem, em quatro chamadas.
Os 28 recursos e o caminho de cada um, com link para o endpoint.
Os mesmos dados expostos como ferramentas para agentes de IA.