A chave de API é a credencial que o sistema da sua empresa usa para falar com a ForSign. Ela substitui o login de uma pessoa: o seu sistema envia a chave em cada requisição e a ForSign reconhece a sua empresa. A chave fica no Painel do desenvolvedor.
Quando usar
- Você vai integrar o seu sistema (ERP, CRM, sistema de RH) com a ForSign.
- Um desenvolvedor ou parceiro pediu a chave para começar a integração.
- Você precisa trocar a chave porque ela pode ter vazado.
Copiar a chave
-
No menu, clique em Desenvolvedor. O Painel do desenvolvedor abre com as abas Monitoramento, Logs e Configurações.
O menu Desenvolvedor abre o Painel do desenvolvedor, com as abas Monitoramento, Logs e Configurações. Ver a tela inteira -
Clique na aba Configurações. No bloco Chave da API, a Chave atual aparece mascarada.
Em Configurações, o bloco Chave da API mostra a Chave atual, sempre mascarada, com os botões para ver e copiar. Ver a tela inteira -
Clique no ícone de cópia ao lado da chave. Use o ícone de olho só se precisar conferir a chave na tela.
- Guarde a chave em um cofre de senhas ou de segredos. Não envie por e-mail nem cole em planilhas.
Usar a chave
Envie a chave no cabeçalho X-Api-Key em toda requisição à API. Se o seu sistema preferir um token, ele pode trocar a chave por um token de acesso na rota de autenticação. Os detalhes estão em Primeiros passos com a API v2 e no link Ir para documentação, ao lado da chave.
Trocar a chave
- No mesmo bloco, clique em Alterar chave.
- A janela Alterar chave atual avisa que as integrações que usam a chave podem parar de funcionar. Confirme.
- A chave antiga deixa de valer na hora e a nova aparece no campo. Atualize a chave em todos os sistemas que a usam.
Não existe período de convivência entre a chave antiga e a nova. Combine a troca com quem cuida das integrações.
O que acontece depois
- As ações feitas com a chave ficam registradas no feed da operação com a origem API.
- A chave age com as permissões de um usuário ativo da empresa. O que a chave pode fazer segue o perfil de acesso desse usuário.
Limites e detalhes
- A chave não expira sozinha. Recomendamos trocar a chave periodicamente, por exemplo a cada 90 dias.
- Para ver e trocar a chave, o seu perfil precisa da permissão de gerenciar integrações.
- O Painel do desenvolvedor não fica disponível durante o período de teste.
- A chave precisa de pelo menos um usuário ativo na empresa para funcionar.
- Consultar ou trocar a chave não consome crédito.
Perguntas comuns
A chave vence em 24 horas? Não. A chave vale até alguém clicar em Alterar chave.
Vários sistemas usam a chave. Como troco sem parar tudo? Prepare a troca em todos os sistemas antes. Clique em Alterar chave e atualize a chave nova em todos logo em seguida.
A chave vazou. O que faço? Clique em Alterar chave imediatamente. A chave antiga deixa de funcionar na hora.