Como criar uma chave de API e acessar a documentação
Crie uma chave de API com as permissões certas para integrar o seu sistema ao Cognizy e abra a documentação da API.
1 min de leituraBásicoAtualizado em 12 de novembro de 2026
Onde fica no Cognizy
Videoaula em breve. Por enquanto, siga o passo a passo abaixo.
A chave de API autentica as integrações com o Cognizy. Cada chave tem um ambiente (produção ou sandbox) e só as permissões que você marcar. A documentação traz a referência completa e um início rápido.
Onde fica no Cognizy
Antes de começar
- Plano com acesso à API.
- Só o dono e os administradores criam chaves.
- Guarde a chave num lugar seguro: quem tem a chave acessa a sua organização.
Passo a passo
- Passo 1:
Abra . Em Chaves de API, veja o uso do mês e clique em Nova chave.
- Passo 2:
Dê um Nome, escolha o Ambiente (SANDBOX (TEST) para testar, PRODUÇÃO (LIVE) para valer) e marque só as Permissões que a integração precisa, módulo por módulo.
- Passo 3:
Clique em Nova chave, no fim da janela. A chave aparece uma vez só: copie e guarde no seu sistema.
- Passo 4:
Na aba Documentação, clique em Abrir documentação interativa para ver todas as rotas, ou baixe o OpenAPI JSON. O Início rápido mostra a primeira chamada.
Como saber que deu certo
A chave aparece na lista (sem o segredo) com o ambiente e as permissões. A integração passa a autenticar com ela.
Se der errado
A API responde que não tem permissão.
A chave não tem a permissão daquele módulo. Crie outra chave com a permissão certa.
Perdi a chave.
Ela não aparece de novo. Apague a chave antiga e crie uma nova.
Próximo passo
Cadastre um webhook para receber os eventos.
Para desenvolvedores
Entre com a sua conta Cognizy para salvar o progresso.
Entrar