Access tokens

Access Token

Um Access Token representa o detentor dos dados que um App consome. Normalmente, um Access Token é gerado quando o dono dos dados de consumo deseja que uma App externa faça acesso direto a esses dados.

Um Access Token só é obrigatório em uma requisição se a API for configurada para requerir um Access Token Validation. É utilizada em conjunto com uma App para permitir o acesso a API.

A tela de visualização e cadastro de Access Token pode ser acessada via menu lateral, como ilustrado abaixo:

Cadastro de Access Tokens

Para cadastrar um Access Token, deve-se clicar em "Create Access Token" e será habilitado um wizard para ajudar no cadastro.

Overview

O primeiro passo para cadastrar um Access Token é a tela de Overview. Nela temos alguns campos para serem preenchidos. Alguns deles, marcados com asterisco, são obrigatorios:

  • Owner: Representa o nome do dono do Access Token. Para que o Owner tenha acesso ao Code, mesmo que não tenha permissão de Secret, é necessário informar o login ou email do respectivo usuário.

  • Code: Indica qual o código que o Token terá. Podemos setar um valor, usando uma combinação de letras e/ou números no token ou então, podemos deixar o campo vazio, assim o código será gerado automaticamente;

  • APP: Este campo é usado para realizar o vínculo de uma App a um Access Token. Ele possui um autocomplete que retorna as Apps cadastradas para facilitar a seleção.

  • STATUS: Indica qual o estado do token. Ele pode possuir apenas dois estados: ACTIVE, que indica que aquele token pode ser usado em chamadas e REVOKE, que indica que o token está impedido de ser usado em chamados. Este campo não pode ser editado, pois os status são atribuidos automaticamente.

  • Extra Fields: Uma série de campos que podem ser usados para complementar as informações de um Access Token. Por exemplo, se o token possuir um sellerId ou um skuId, estas informações podem ser colocadas nestes campos.

Plans

Para o segundo passo, temos a escolha da API que este Access Token estará associado, como ilustrado na imagem a seguir:

O processo de escolha de Planos para o Access Token é similar ao que ocorre no cadastro de App. Para mais informações, acessar o tópico Plan no capítulo App.

Summary

Após a seleção do plano, o usuário será direcionado para o terceiro e último passo, a tela de Summary. Nesta tela, temos apenas um resumo de todas as informações que foram inseridas no Access Token.

Se as informações estiverem corretas, o usuário deve clicar no botão "PUBLISH YOUR ACCESS TOKEN" para confirmar a operação. Logo após, será mostrado uma tela de sucesso da operação de cadastro e o token poderá ser visto na listagem de Access Tokens.

Na tela acima podemos ver novamente a presença do botão COPY com a função de copiar o código do Access Token gerado para usos diversos, e também o botão GO TO ACCESS TOKEN LIST que possui o objetivo de direcionar o usuário para a tela de listagem de Access Tokens.

De volta a tela de listagem, é possivel editar um Access Token cadastrado utilizando o botão , e para remover, utiliza-se o botão

Revogação de Access Tokens

A revogação de um Access Token é equivalente a ação de desativação. Uma revogação pode acontecer quando o dono do token não quer mais que aquele token seja utilizado nas requisições.

Para revogar um token, na tela de listagem, clique no CODE do token e você será direcionado para a tela abaixo:

Nesta tela existe um botão "REVOKE". Ao clicar neste botão, será exibida uma mensagem de aviso, alertando que o token ao ser revogado, se for usado em Requests, irá gerar erros do tipo 403 com a mensagem de token expirado.

Caso o usuário realmente deseje revogar o token, deve-se clicar em "CONFIRM" e a operação será completada.