A Chave de API funciona como uma ponte segura que conecta o Checklist Fácil a outros sistemas externos. Ela é utilizada para autenticar e permitir a troca de dados entre sua conta e outras aplicações que sua empresa utiliza.
Por ser um recurso que lida diretamente com a segurança das informações, sua criação exige permissões específicas e cuidados importantes.
Atenção com a segurança dos dados A chave da API concede acesso total a todas as informações contidas no sistema. Qualquer pessoa em posse desta chave terá acesso pleno aos dados da base, mesmo que não tenha um usuário cadastrado na plataforma. Por isso, compartilhe essa chave apenas com pessoas de extrema confiança e desenvolvedores responsáveis pela integração.
Como criar uma nova Chave de API
Para gerar uma nova chave, siga os passos abaixo:
- No menu lateral, acesse a aba Integrações;
- Selecione a opção Chaves de API;
- Clique no botão NOVO.
Na tela de cadastro, preencha as seguintes informações:
- Nome: Crie uma identificação para saber onde essa chave está sendo usada (ex: Integração PowerBI, Sistema de RH, etc.);
- Usuário: Selecione um usuário responsável pela chave.
Requisito de Permissão Apenas usuários com o perfil de Administrador Geral podem criar ou ser vinculados a uma chave de API. O sistema não permite a geração de chaves para outros tipos de perfil devido ao nível de acesso aos dados.
Salvando e armazenando sua chave
Ao clicar em SALVAR, o sistema irá gerar e exibir a sua chave alfanumérica na parte inferior da tela.
Copie sua chave agora! Por medidas de segurança, a chave só é exibida uma única vez no momento da criação. Copie o código e salve em um local seguro imediatamente. Caso você perca essa informação, será necessário excluir a chave antiga e criar uma nova, reconfigurando suas integrações.
Nota técnica: Essa chave utiliza o padrão Bearer token. Certifique-se de configurar sua aplicação externa para reconhecer este método de autenticação corretamente.
Perguntas Frequentes (FAQ)
1. Posso limitar os dados que a API acessa?
Não. A nossa API não limita quais dados podem ser acessados. A partir do momento que uma chave é gerada, ela concede acesso pleno à base de dados da empresa.
2. O que acontece se eu compartilhar a chave com alguém que não tem usuário?
A pessoa conseguirá acessar os dados via integração. O vínculo com um usuário "Administrador Geral" serve para gerar a chave, mas quem possuir o código da chave conseguirá realizar as requisições no sistema, independente de ter login ou não.
3. Perdi minha chave, consigo recuperá-la?
Não é possível visualizar a chave novamente pelo sistema por segurança. Neste caso, você deve excluir a chave antiga (clicando na lixeira ao lado do nome dela) e criar uma nova.
❓Tem dúvidas? Entre em contato com nosso time de suporte.