UNO CRM - API Pública

Bem-vindo à documentação da API pública do UNO CRM. Esta API permite que sistemas externos integrem-se ao seu CRM para criar leads, consultar funis, estágios, origens e campanhas.

• URL base (produção): https://public-api.unocrm.com.br

Autenticação

Todas as requisições à API pública precisam ser autenticadas através de uma API Key, enviada no cabeçalho HTTP X-Api-Key.

GET /v1/funis HTTP/1.1
Host: public-api.unocrm.com.br
X-Api-Key: sua-api-key-aqui

Caso a chave esteja ausente ou inválida, a API responde com 401 Unauthorized.

Como gerar uma API Key

1. Acesse o UNO CRM com um usuário que tenha permissão para gerenciar configurações.
2. No menu lateral, vá em Configurações > Chave de API.
3. Clique em Nova chave, informe um nome de identificação e confirme.
4. Copie a chave gerada e armazene em local seguro. Por motivos de segurança, ela não poderá ser visualizada novamente após o fechamento da tela — caso seja perdida, será necessário gerar uma nova.

Vínculo com o usuário

Cada API Key fica vinculada ao usuário que a criou. Isso significa que:

• Todas as ações executadas via API (ex.: criação de leads, atribuições) são registradas em nome desse usuário.
• Se o usuário for desativado ou removido, suas chaves deixam de funcionar.
• Para revogar uma chave, basta excluí-la na mesma tela de Configurações > Chave de API.

Boa prática: crie um usuário dedicado para integrações externas, evitando vincular chaves a contas pessoais.

Rate limiting

Para proteger a estabilidade do serviço, todas as rotas da API pública estão sujeitas a um limite de requisições.

• Limite padrão: 30 requisições por minuto, por API Key.
• Quando o limite é excedido, a API retorna 429 Too Many Requests com a mensagem:
  JSON

  {
    "success": false,
    "message": "Rate limit excedido. Tente novamente em breve."
  }

• O contador é reiniciado automaticamente após a janela de 1 minuto. Implemente retry com backoff exponencial para lidar com picos de tráfego.

Formato das respostas

Todas as respostas seguem um envelope padronizado em JSON.

Sucesso:

{
  "success": true,
  "data": { }
}

Erro:

{
  "success": false,
  "message": "Descrição do erro"
}

Códigos de status comuns

Próximos passos

Consulte a especificação OpenAPI (public-api.openapi.yaml) para a referência completa dos endpoints, parâmetros e schemas disponíveis.