A API Key e o Secret são as credenciais que permitem a um sistema seu acessar os dados do Base pela API. Você cria as duas a partir de um usuário do ambiente, feito só para isso.
Quem pode fazer: pessoas com Pode Administrar na organização. Veja Permissões e acessos no Base.
Antes de começar: o e-mail de um usuário de API usa um domínio próprio para chaves de API. Peça esse domínio ao suporte da Droz antes de criar o usuário.
O que são a API Key e o Secret
Para o Base, uma chave de API é um usuário que entra com e-mail e senha, como qualquer outro. A diferença é que o e-mail desse usuário usa o domínio próprio para chaves de API.
| Credencial | O que é |
|---|---|
| API Key | O e-mail do usuário criado para a chave. |
| API Secret | A senha desse usuário. |
Crie o usuário da chave (API Key)
- Clique na sua foto, no canto superior direito, e vá em Configurações do ambiente > Gerencie seu time > Usuários.
- Clique em Novo Usuário. Abre a janela Criar perfil de usuário.
- Em Nome do Usuário, descreva para que a chave serve, como "Integração com o CRM". Isso ajuda a saber, depois, de onde vêm os acessos.
- Em Email, escreva o nome que quiser antes do @ e, depois dele, o domínio próprio para chaves de API.
- Clique em Criar Usuário. O e-mail desse usuário é a sua API Key.
Gere a senha da chave (API Secret)
- Na lista de Usuários, ache o usuário que você acabou de criar. Se precisar, use a busca Pesquise por usuários.
- Clique no menu ⋮ da linha dele e escolha Reset de Senha.
- Defina a nova senha. Ela é o seu API Secret.
Atenção: a API Key e o Secret funcionam juntos como um usuário e uma senha. Quem tiver os dois acessa a API do Base com todas as permissões desse usuário. Trate o par como uma senha: guarde com segurança, não compartilhe e não deixe em arquivos ou códigos que outras pessoas possam ver.
Se suspeitar que a chave vazou, gere um novo Secret na hora com Reset de Senha. O Secret antigo deixa de valer.
Defina as permissões da chave
O usuário da chave enxerga apenas o que as permissões dele permitem. Configure o acesso dele como faria com qualquer usuário e conceda só o que a integração precisa.
Dica: crie uma chave para cada integração. Se um sistema deixar de ser usado ou a chave vazar, você desativa só aquele usuário, sem afetar as outras integrações.