O API Token é a principal forma de autenticação para realizar uma operação em sua conta iugu através da nossa API. Porém, existem outros tipos de tokens, como o master token ou o user token, que são utilizados para operações específicas.
Objetivo da FAQ
O objetivo dessa FAQ é esclarecer o que é o Master Token, seus benefícios e como ele impacta a operação dos clientes, além de orientar sobre sua utilização e melhores práticas.
Sumário
- O que é o Master Token?
- Como funciona o Master Token?
- Quais as vantagens e diferenciais?
- Quando e como utilizar o Master Token?
1. O que é o Master Token?
O Master Token é um novo tipo de chave para utilização da API iugu. Ele foi criado com o intuito de aumentar a segurança nas rotas de Criação, Listagem e Exclusão de API Tokens.
O uso dessa nova chave será obrigatório para essas rotas citadas, garantindo um processo mais seguro para a sua operação, clique aqui para mais informações.
2. Como funciona o Master Token?
A autenticação na iugu é realizada por meio de uma “Chave de API” (API Token), que permite ao sistema identificar a sua conta e conceder as permissões necessárias para a comunicação com a iugu em nome da conta associada.
Ao gerar uma chave em sua conta iugu, você terá três tipos de API Tokens disponíveis: a “Teste” (test) para utilização em ambiente homologado, a chave de “Produção” (live) para executar ações em ambiente real e a chave “Mestre” (master), para gestão das demais chaves através da nossa Documentação API.
3. Como gerar um Master Token?
Para gerar essa chave, será necessário acessar sua conta iugu via painel:
- Ao acessar sua conta iugu, vá em “Configurações”;
- Procure a seção “DESENVOLVEDOR – Integração via API” e clique em “Novo”;
- Em “Tipo” selecione o tipo de chave “Mestre” e depois informe um nome para essa chave no campo “Descrição”;
- Para que essa chave seja autorizada em nossas endpoints, será necessário configurar o processo de Assinatura RSA informando uma chave pública (veja mais detalhes em nosso artigo clicando aqui);
- Para concluir, clique em “Salvar” e confirme o processo utilizando o iugu token na dupla autenticação.
- Atenção! O Token gerado só ficará visível durante 1 hora após sua criação. Por isso, não se esqueça de copiá-lo e guardá-lo em um ambiente seguro.
Obs.: Sugerimos que essa ação seja realizada apenas por usuários com a permissão “Administrador” e apenas estes mesmos usuários ou pessoas de confiança tenham acesso para utilizar o Master Token.
4. Quando e como utilizar o Master Token?
O Master Token funcionará como uma chave principal, sendo utilizado sempre que for necessário executar nossa API para gestão dos tokens da sua conta mestre ou subconta.
O uso do Master Token é obrigatório para executar as seguintes endpoints:
| Referência da API | Endpoint |
|---|---|
| Criar API Token | v1/{account_id}/api_tokens |
| Listar API Tokens | v1/{account_id}/api_tokens |
| Remover API Token | v1/{account_id}/api_tokens/{id} |
ATENÇÃO: O Master Token é necessário apenas para as chamadas listadas acima, os tokens de teste e produção já criados anteriormente para outras rotas continuam funcionando normalmente.
0 Comentários