Passo 1: Token API

📘

O que você irá aprender com esse artigo?

  • Habilitar a conta em modo teste no painel
  • Criar o token de teste para usar a API
    - Marketplace
    - Onde faturar

Habilitar a conta em modo teste no painel

Via painel, é possível habilitar o modo de teste clicando no nome de usuário, localizado no canto superior direito da tela. Nesse modal, clique em “MODO TESTE” para habilitá-lo.

Ao lado do nome de usuário, é exibido qual o ambiente está sendo usado no momento. Quando o modo de teste está habilitado, todas as faturas, clientes, assinaturas, etc. são referentes ao ambiente de teste. Então, se for pesquisado o id de uma fatura que foi criada em produção, com a conta operando em modo teste, essa fatura não será encontrada.

Falando exclusivamente do painel, se o modo teste estiver habilitado, então já pode ser criado faturas, clientes e assinaturas de teste. Quando se trata de API, é necessário usar o token de teste para a criação.

Criar o token de teste para usar a API

Para gerar o token de teste, basta acessar o painel da conta e clicar em: Configurações >> Integração via API >> Novo.

Quando clicar no botão Novo, aparecerá uma tela para definir o tipo do token (produção ou teste) e a descrição.

Depois de definir essas configurações é só clicar em “Salvar”. O novo token gerado aparecerá na lista de tokens na última página.

Caso houver muitos tokens criados, acesse a última página para visualizar o token gerado.

É importante ressaltar que o token fica disponível para visualização em um período de até 1 hora, após isso ele ficará indisponível (como os tokens anteriormente exibidos na imagem acima). O token não expira, portanto basta salvá-lo para usar quando quiser. O mesmo processo deve ser utilizado para gerar o token de produção, bastando alterar o tipo do token para “Produção”.

Veja como autenticar via API aqui.

Marketplace - Conta Mestre

Em um cenário de Marketplace, há conta mestre e subconta. Veja sobre a criação da subconta aqui.

Para criar token na conta mestre, basta seguir o passo a passo citado no tópico anterior: Criar token de teste para usar a API

Marketplace - Subconta

No caso de subconta, para quem possui plano de Marketplace, ao criá-la via API, é retornado o token de produção (live_api_token), o token de usuário (user_token) e o token do ambiente de teste (test_api_token). Armazene essas informações do seu lado.

O user_token só pode ser gerado na criação da subconta via API. O token de teste e de produção podem ser gerados na criação da subconta ou via API, utilizando a chamada de Criar API Token. No entanto, essa chamada necessita de autenticação pelo user_token. Caso não tenha o user_token da subconta, então é preciso criar o token via painel.
Veja mais detalhes sobre os tokens das contas aqui.

Para gerar o token da subconta, acesse a conta mestre e clique no menu de Marketplace. Na tela seguinte, procure a subconta criada e clique no botão “Ver”. No final da página de detalhes da subconta, clique no botão “Inspecionar” para visualizar o portal sob a perspectiva da subconta. Perceba que o nome no canto superior esquerdo da tela irá mudar, pois a visualização saiu da conta mestre para a visualização da subconta. Estando com o painel aberto na subconta, basta seguir o passo a passo anteriormente mencionado: Configurações >> Integração via API >> Novo.

Onde faturar

A fatura é gerada na conta que foi usada na autenticação da API. Ou seja, se utilizar o token da conta mestre para gerar a fatura, então é faturado na conta mestre (e a mesma paga as taxas iugu). Em contrapartida, caso utilize o token da subconta na criação da fatura, então é faturada na subconta (e ela paga as taxas iugu).

🚧

Atenção!

Após realizar o passos de integração e finalizar os testes, será preciso alterar o token de testes (test_api_token) para o token de Produção (live_api_token).


Did this page help you?