Passo A Passo - Autenticação Do Token para Chamada Na API - Comtax

07/03/2024, 11:41 Passo a Passo - Autenticação do Token para Chamada na API | Comtax
Passo a Passo - Autenticação do Token para Chamada na

API
Site: Comtax Impresso por: Carlos Tadeu Yshimaru Alves
Curso: AvaTax-Brasil - API Data: quinta-feira, 7 mar 2024, 11:41
Livro: Passo a Passo - Autenticação do Token para Chamada na
API
https://www.universidadeavalara.com.br/mod/book/tool/print/index.php?id=4727 1/12
Índice
1. Passo a Passo - Token
2. Configuração do POSTMAN
3. Avalara – Autenticação SDX
1. Passo a Passo - Token

O objetivo desse documento é estabelecer um passo a passo para realizar os processos de autenticação por meio de token para chamadas
de API (Application Programming Interface) que é uma interface de programação de aplicação. API é um conjunto de normas que possibilita
a comunicação entre plataformas através de normas e protocolos.
2. Configuração do POSTMAN
Para que seja realizada a simulação de emissão de nota fiscal de serviço ou mercadoria, baixe o aplicativo do Postman e configure,
conforme os passos a seguir:
1. Clique em Start with something new
2. Clique em HTTP REQUEST
3. Selecione o metodo Post e insira a seguinte url para teste de conexão do token: https://api-
gateway.sandbox.avalarabrasil.com.br/oauth/token
4. Utilize o select a seguir no campo Body:

{
"grant_type": "client_credentials",
"client_id": Assinatura criada no portal do cliente
"client_secret": Segredo criado no portal do cliente
"disableTokenRefresh": true
}
5. Clique em SEND para testar conexão
Após o teste, os dados de token estão disponíveis, para inserir posteriormente nas chamadas dos endpoints de nota fiscal de serviço e
mercadoria:
6. Insira o token gerado no campo Token e selecione Bearer token no campo type
Simulando uma chamada de emissão de documento fiscal de serviço:

URL: https://avataxbr.sandbox.avalarabrasil.com.br/v3/invoices/services
7. Insira o Json de envio no campo Body
8. Após inserir, basta clicar em SEND que o sistema retorna a mensagem da prefeitura, se a nota foi efetivada ou rejeitada e qual o motivo.
3. Avalara – Autenticação SDX

Passo 1: Como criar um token de acesso à API por meio do Portal Avalara:
Acesse o portal Avalara: https://portal.sandbox.avalarabrasil.com.br/ e efetue o login:
Ir em Configurações/ Tokens de Assinatura
Clicar em Novo Token de Assinatura:
NOME: preencher com o time ou responsável que utilizará a credencial.

DATA INÍCIO: a data a partir da data de criação.
DATA FIM: conforme necessidade.
Clicar no botão “Salvar”.

São geradas as credenciais do token que deven ser salvas, pois não tem recuperação.
Importante: os dados no campo Assinatura devem ser utilizados na tag "client_id" e os dados do campo Segredo do Token devem
ser utilizados na tag "client_secret"
Nota: Recomenda-se, de acordo com as boas práticas, que caso exista mais de um ERP sendo integrado, que utilize-se um Token de
Autenticação por ERP.
Auditoria
Após o Token criado, como forma de segurança e auditoria, é possível visualizar os seguintes dados:
Nome do Token Gerado
Login do Criador do Token
Nome do Criador do Token
Data de Criação do Token
Data de Inicio do Token
Data de Expiração do Token
Status do Token
Autenticação
O processo de autenticação é feito pela opção OAuth, ou seja: 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.
O “Access Token” tem validade e, após o vencimento, é necessário que uma nova validação com as credenciais seja enviada.
É possível ainda fazer a renovação do “Access Token”, ou enviar 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.
Segue descrição funcional de como realizar cada uma das chamadas.
Passo 2: Como conseguir um “Access Token”?
URL: https://api-gateway.sandbox.avalarabrasil.com.br/oauth/token
Campos Atributos Descrição
Obrigatórios/Sugeridos
Obrigatório grant_type Para a requisição inicial de um “Access Token” deve-se enviar o valor descrito abaixo:
“client_credentials”
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 disableTokenRefreshEsta 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 3 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”
Passo 3: Baixar aplicativo de teste API POSTMAN

Baixar o aplicativo Postman:
https://www.postman.com/downloads/
Acessar o aplicativo:
Clicar no (+) ao lado do Collections:
É criada uma coleção onde podem ser criadas várias chamadas (Requests).
Clique em ADD Request para criação de uma chamada Token.
Preencha a URL do token na chamada
Clicar em Body.
Flegar Raw
Clicar opção Json
Preencher os parâmetros das credenciais do token.

{
"grant_type":"client_credentials",
"client_id":"XXXXXXXXXXXXXXXXXXXXXXXXXX",
"client_secret":"X9X9X9XX9X9XX9X9X9X9X9XX9X9X",
"disableTokenRefresh": true
}
Após preencher as credenciais, clicar no botão enviar.
É gerado o Access Token. É este acesso que é utilizado nas chamadas de API.
Passo 5: Como fazer simulação com Request

Tenha a chamada request que poderá ser do conector ou do AvaTax.
Abra uma nova request, clicar nos 3 pontos ao lado da colection criada.
Edite a descrição de sua request e preecha a URL conforme documentação. No exemplo abaixo, será preenchido com a URL de cálculo de
impostos.
https://avataxbr.sandbox.avalarabrasil.com.br/v3/calculations
Coloque os parâmetros na Request.

Clicar em Body
Flegar Raw
Clicar opção Json
No corpo, colar a chamada request da API.
Ir na caixa do Body e na lista clicar em Authorization.

Cole na caixa token todo access_token, só não copie as aspas (“”).
Clicar em Send (enviar)
É gerado o response do cálculo.
Para salvar o Json do response escolher a opção desejada.

Passo A Passo - Autenticação Do Token para Chamada Na API - Comtax

Enviado por

Dados do documento

Título original

Direitos autorais

Formatos disponíveis

Compartilhar este documento

Compartilhar ou incorporar documento

Opções de compartilhamento

Você considera este documento útil?

Este conteúdo é inapropriado?

Direitos autorais:

Formatos disponíveis

Passo A Passo - Autenticação Do Token para Chamada Na API - Comtax

Enviado por

Direitos autorais:

Formatos disponíveis

07/03/2024, 11:41 Passo a Passo - Autenticação do Token para Chamada na API | Comtax

Passo a Passo - Autenticação do Token para Chamada na

1. Passo a Passo - Token

2. Clique em HTTP REQUEST

4. Utilize o select a seguir no campo Body:

5. Clique em SEND para testar conexão

Simulando uma chamada de emissão de documento fiscal de serviço:

3. Avalara – Autenticação SDX

Clicar em Novo Token de Assinatura:

NOME: preencher com o time ou responsável que utilizará a credencial.

Clicar no botão “Salvar”.

Passo 2: Como conseguir um “Access Token”?

Passo 3: Baixar aplicativo de teste API POSTMAN

Clicar no (+) ao lado do Collections:

Preencha a URL do token na chamada

Preencher os parâmetros das credenciais do token.

Após preencher as credenciais, clicar no botão enviar.

Passo 5: Como fazer simulação com Request

Coloque os parâmetros na Request.

No corpo, colar a chamada request da API.

Ir na caixa do Body e na lista clicar em Authorization.

Clicar em Send (enviar)

É gerado o response do cálculo.

Para salvar o Json do response escolher a opção desejada.

Você também pode gostar