Quickstart

Da conta zerada ao primeiro contato cadastrado, em 3 chamadas.

Crie a conta

POST/v1/auth/register

{
  "tenantName": "Minha Empresa",
  "name": "Seu Nome",
  "email": "voce@empresa.com",
  "password": "..."
}

Guarde o accessToken da resposta — ou crie uma API Key assim que tiver um tenant, se preferir integrar via backend em vez de sessão de usuário.

Cadastre seu primeiro contato

POST/v1/contacts

curl -X POST https://api.allyone.com.br/v1/contacts \
  -H "Authorization: Bearer eyJhbGci..." \
  -H "Content-Type: application/json" \
  -d '{
    "firstName": "Maria",
    "phone": "+5511999998888",
    "optInWhatsapp": true
  }'

email ou phone — pelo menos um dos dois é obrigatório.

Conecte um canal e fale com esse contato

Integrações enviam mensagens por um dos três motores de automação ou por uma campanha, sempre associadas a um canal conectado. (Responder dentro de uma conversa aberta, como um atendente faz na inbox, usa POST /v1/chat/conversations/:id/messages com sessão de usuário.) O caminho mais curto até uma mensagem real:

Conecte um número de WhatsApp via Embedded Signup.
Crie um Chat Flow simples, ou dispare uma campanha manual para o contato que você acabou de criar.

Pronto

Você tem uma conta, um contato e sabe onde conectar o primeiro canal. Próximo passo natural: Conectar WhatsApp.

OpenAPI e Postman

A superfície de integração do CRM (autenticação, chaves de API, contatos, listas, segmentos, campanhas, formulários, vendas, conversas, WhatsApp e webhooks) está descrita em OpenAPI 3.1 e numa coleção Postman. Importe no Postman, Insomnia ou no gerador de SDK da sua escolha.

Especificação OpenAPI — crm-openapi.json
Coleção Postman — crm.postman_collection.json

Rotas fora da especificação são internas e podem mudar sem aviso. Um teste automatizado compara a especificação com o código a cada alteração, então ela não fica para trás.