API — introdução e autenticação

A API permite que outros sistemas (ERP, CRM, loja virtual, N8N, um script seu) enviem mensagens e consultem ou alterem dados no Jarvis.

Criar o acesso#

1. Acesse Automação e Integrações → API.
2. Clique em Adicionar e escolha o canal que a API vai usar para enviar mensagens.
3. Gere o token.
4. Baixe o modelo do Postman disponível na tela.

Cada acesso de API fica ligado a um canal. Para enviar por números diferentes, crie um acesso para cada canal.

URL base#

Cada acesso tem uma URL base própria, mostrada na tela de API e no modelo do Postman. No Jarvis, ela segue este formato (troque SEU_ID pelo ID do seu acesso):

https://apichat.jarvisassistente.com.br/v1/api/external/SEU_ID

Nesta documentação, chamamos esse endereço de URL_BASE. Os endpoints são acrescentados ao final, por exemplo URL_BASE/createcontact.

Autenticação#

Envie o token no cabeçalho Authorization:

Authorization: Bearer SEU_TOKEN
Content-Type: application/json

Formatos#

Número de telefone

DDI + DDD + número, só dígitos: 5511999999999. Para grupos, use o ID do grupo terminado em @g.us. Em canais sem telefone (como Instagram), use ticketId no lugar do número.

Datas

Sempre com fuso horário: 2026-08-25T14:30:00-03:00.

Status de atendimento

pending, open ou closed.

externalKey

Um identificador seu para rastrear a mensagem (deve ser único por mensagem). Ele volta nos webhooks.

Exemplo: enviar uma mensagem de texto#

curl -X POST "URL_BASE" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "5511999999999",
    "body": "Olá! Seu pedido #1234 saiu para entrega.",
    "externalKey": "pedido-1234-entrega"
  }'

Códigos de erro#

Próximo passo#

Veja todos os recursos disponíveis em Referência de endpoints.