A API externa é autenticada por uma apikey própria da sua empresa —
diferente do login (e-mail/senha) usado no portal. Ela nunca expira sozinha;
fica ativa até ser revogada.
Gerando sua chave
- Entre no portal com um usuário administrador da sua empresa.
- Abra o menu do usuário (canto superior direito) → Apikey.
- Clique em Criar apikey.
- Copie a chave exibida — ela só aparece uma única vez, nesse momento.
Se perdê-la, gere uma nova (a anterior é revogada automaticamente).
Só existe uma chave ativa por empresa por vez. Gerar uma nova sempre
revoga a anterior — qualquer integração usando a chave antiga para de
funcionar imediatamente.
Usando a chave
Envie a chave no header X-API-Key em toda requisição:
Uma chave ausente, inválida ou revogada retorna 401 Unauthorized.
Testando pela documentação
Cada página em Referência da API tem um botão
Authorize (ou um campo de apikey no painel de teste) — cole sua chave lá
para testar os endpoints direto pelo navegador, sem precisar montar a
chamada manualmente.
Revogando
Na mesma tela Apikey do portal, o botão Revogar desativa a chave
ativa imediatamente — use se a chave vazar ou uma integração for
descontinuada. 