Criar sua API key
Crie no IAM a API key que a sua integração usa para obter tokens, uma por ambiente.
A API key é a credencial da sua integração: um client_id e um client_secret que você troca por um token de acesso para chamar as APIs da Tax360. Ela é criada e gerenciada no IAM, pelo próprio usuário da sua empresa.
Entre para ver os links do IAM de cada ambiente.
Antes de começar
- Você precisa de um usuário da sua empresa com acesso ao IAM e permissão para gerenciar API keys. O acesso é criado pelo suporte.
- Uma chave por ambiente. A chave criada no UAT não funciona em Produção, e vice-versa.
Criar a chave
- Abra o IAM do ambiente desejado pelos botões acima e vá em API keys.
- Clique em criar e informe:
- Nome: identifique a integração, por exemplo
erp-faturamento. - Validade do token: por quanto tempo cada token gerado com esta chave vale.
- Roles: as permissões que a integração precisa. Conceda só o necessário para as operações que ela vai chamar.
- Nome: identifique a integração, por exemplo
- Copie o
client_ide oclient_secretexibidos.
O secret é exibido uma única vez
Guarde o client_secret num cofre de segredos logo após a criação. Se ele for perdido ou exposto, revogue a chave no IAM e crie outra.
Usar a chave
Troque o client_id e o client_secret por um token com o grant client_credentials:
Gerar token de acesso
POST/api/integration/auth/tokenEntre para ver o host e a referênciaO passo a passo, com exemplos e renovação do token, está em Autenticação. Os hosts de cada ambiente estão em Ambientes e hosts.
Boas práticas
- Use uma chave por integração e por ambiente, para poder revogar uma sem afetar as outras.
- Nunca coloque o secret no código-fonte, em front-end ou em repositórios.
- Revise as roles quando a integração mudar e revogue as chaves que não são mais usadas.