FAQ - Portal Avalara
3. Portal - Como gerar token de assinatura?
Como gerar token de assinatura:
Importante: para esta configuração, o usuário deve ter acesso de administrador do portal.
1.º Passo: como criar um token de acesso à API através do Portal Avalara:
Todo o processo de criação do token, e das credenciais necessárias para ter acesso a um token de acesso, são realizados através do Portal Avalara.
Link do Portal Avalara:
https://portal.sandbox.avalarabrasil.com.br/Login
. Realize o login no Portal Avalara e siga as instruções das imagens abaixo:
**Recomenda-se, de acordo com as boas práticas, que caso exista mais de um ERP sendo integrado, que se utilize um Token de Autenticação por ERP.
Autenticação:
Nosso processo de autenticação é feito pela opção OAuth, que quer dizer que, a cada chamada com as credenciais obtidas no processo descrito acima, será possível ter acesso a um “Access Token”, e com este token, ter acesso às nossas aplicações.
Este “Access Token” tem uma validade, sendo necessário que, após o vencimento da mesma, uma nova validação com as credenciais seja enviada.
É possível ainda fazer a renovação deste “Access Token”, ou mandar as credenciais novamente a cada chamada. Porém, este último método é indicado apenas para o tráfego de ambientes não seguros, tais como: ‘interface’ gráfica.
Abaixo, segue descrição funcional de como realizar cada uma das chamadas.
2.º Passo: como pegar um “Access Token”?
URL: https://api-gateway.sandbox.avalarabrasil.com.br/oauth/token
Campos Obrigatórios/Sugeridos | Atributos | Descrição |
Obrigatório | grant_type | Para a requisição inicial de um “Access Token” deve-se enviar o valor descrito abaixo: |
Obrigatório | client_id | Este é o valor obtido no campo “Assinatura” dentro do Portal Avalara, no momento da geração do token. |
Obrigatório | client_secret | Segredo de token único, gerado pelo Portal Avalara. |
Sugerida | disableTokenRefresh | Esta propriedade indica se o requisitante da sessão gostaria de obter, ou não, um “RefreshToken” para renovar a sessão a cada “X” minutos. Caso o requisitante opte por manter a sessão ativa até que ela expire em “X” horas sem uma renovação periódica, então deve-se enviar o valor como “true”, e desta forma, NÃO OBTERÁ um “RefreshToken” |
Veja exemplos de chamadas e retornos, abaixo: disableTokenRefresh
JSON request SEM o valor “disableTokenRefresh”:
JSON request COM o valor “disableTokenRefresh” como “true”:
3.º Passo: como agir caso seu “Segredo de Token” for exposto?
Caso seu “Segredo de Token” seja exposto, é possível revogar a “data fim” do token através do Portal Avalara, conforme ilustrado abaixo, e criar outro conforme ilustrado no início deste documento:
Perguntas relacionadas: |
| Qualquer usuário pode gerar um token de assinatura? |
| Para ter autorização de gerar um "Token de Assinatura" o usuário dever ter perfil de adminstrador do Portal Avalara. |
O que fazer se eu perder ou não tiver salvado meu “Segredo de Token”? |
Caso voce não tenha guardado ou tenha perdido seu “Segredo de Token”, deve-se inativar o token atual, conforme explicado no STEP 4 deste documento, e criar um novo, conforme explicado no STEP 1. |
Onde posso consultar meu “ID de Assinatura”? |
O seu “ID de Assinatura” pode ser consultado de duas maneiras. A primeira deles é no momento da criação do “Segredo de Token”, conforme demonstrado no STEP 1. A segunda maneira é através da barra lateral do Portal Avalara, no campo “Assinatura”, seguindo as instruções abaixo. |
