Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Painel
borderColorgrey
borderStylesolid
 

Token API - Implementação




Painel
borderColorgrey
titleColorWhite
borderWidth1px
titleBGColor#AB0047
titleObjetivo

O que é?

  • Este documento tem como objetivo demonstrar as funcionalidades da API Login que foi desenvolvida para permitir autenticação por token nas APIs.

Quando implementar?

  • Em todo cliente que esteja na versão 08/2021 ou superior e utilize APIs.


Painel
borderColorgrey
titleColorWhite
borderWidth1 px
titleBGColor#AB0047
titleFuncionalidade

API Login  tem como funcionalidade gerar o token que será utilizado nas demais APIs, foi implementada para trazer mais segurança aos nossos clientes, visto que é necessário ter login no solus e fazer a geração do token periodicamente.


Painel
borderColorgrey
titleColorWhite
borderWidth1px
titleBGColor#AB0047
titleOperacionalização

Para a implementação do token temos dois fluxos, um para atender as requisições do SOLUS e outro para fornecedores terceiros.
Necessariamente precisamos fazer primeiro o "Uso das APIs - SOLUS" para conseguirmos fazer o "Uso das APIs - Terceiros".

Expandir
titleUso das APIs - SOLUS

1 - Para a autenticação por token ser utilizada o cliente tem que estar no conceito pessoa.

Estrutural > Configurações > Parametrizações do sistema

Obs: Agendar com o suporte a migração para o conceito pessoa, caso ainda não use.


2 - Criar a pessoa SOLUS (CNPJ) com os dados da SOLUS que será utilizado na criação do operador no passo seguinte.


3 - Criar o operador SOLUS que será vinculado em todas as APIs cadastradas.

Obs: Campo “Nome de login” é de escolha livre.


4 - Verificar se todas as APIs que a Operadora usa estão cadastradas e com as apiKey preenchidas.

Adm > Configurações > Cadastro de API’s


5 - Vincular o operador SOLUS em todas as APIs.

Adm > Configurações > Cadastro de API’s


6 - Obtendo o accessToken do usuário SOLUS.

Adm > Configurações > Cadastro de API’s



7 -  Cadastrar token obtido no passo anterior em "Configuração uso API-Solus".

7.1 - Colar informações obtidas no passo anterior em um notepad.

Image Removed

7.2 - Copiar somente o conteúdo do campo “accessToken”.

Image Removed

7.3 - Colar o token em "Configuração uso API-Solus".

Adm > Configurações > Configuração uso API-Solus

Image Removed

8 - Usar a rota install para validação do processo.

8.

Usararotainstallparagerarotokenprimário.

7.1 - Colar o accessToken obtido no passo anterior na aba “Body”;


87.2 - Na aba “authorization “ configurar a opção type para “Bearer Token“;


87.3 - Copiar somente o conteúdo do campo “accessToken”;


87.4 - Colar no campo “Token” na aba “Authorization” o conteúdo copiado no passo anterior;


87.5 - Podemos efetuar a requisição clicando em “Send” e assim teremos o token primário.


Obs: O token primário nesse processo simboliza apenas sucesso, não utilizaremos.8 - Cadastrartokenretornadodarotainstallem"ConfiguraçãousoAPI-Solus".

Image Added




Expandir
titleUso das APIs - Terceiros

1 - Para a autenticação por token ser utilizada o cliente tem que estar no conceito pessoa.

Estrutural > Configurações > Parametrizações do sistema

Obs: Agendar com o suporte a migração para o conceito pessoa, caso ainda não use.


2 - Criar a pessoa para o fornecedor que será usada na criação do operador no passo seguinte.


3 - Criar o operador para o fornecedor que será vinculado nas APIs que ele utiliza.

Obs: Campo “Nome de login” é de escolha livre.


4 - Verificar se todas as APIs que o fornecedor usa estão cadastradas e com as apiKey preenchidas

Adm > Configurações > Cadastro de API’s


5 - Vincular o operador nas APIs necessárias e determinar o mesmo tempo (Token expira (minutos)) acordado em cada uma delas.

Adm > Configurações > Cadastro de API’s


6 - Obter accessToken do usuário "fornecedor".

Adm > Configurações > Cadastro de API’s


7 - Usar a rota install para gerar o token primário.

7.1 - Colar o accessToken obtido no passo anterior na aba “Body”;


7.2 - Na aba “authorization “ configurar a opção type para “Bearer Token“;

7.3 - Copiar somente o conteúdo do campo “accessToken”


7.4 - Colar no campo “Token” na aba “Authorization” o conteúdo copiado no passo anterior;


7.5 - Podemos efetuar a requisição clicando em “Send” e assim teremos o token primário.


8 - Usar a rota login por usuário e senha para obter o token que será usado nas demais APIs (secundário).

8.1 - Em login e senha informar  os valores obtidos no acessToken;


8.2 - Preencher o campo “Token” na aba “Authorization” com o token que obtivemos na rota install (primário);


8.3 - Podemos efetuar a requisição clicando em “Send” e assim teremos o Token para uso nas demais APIs (secundário).




Informações
titleInformações

Dúvidas sobre o processo de token para APIs.

  • O que fazer quando o token do fornecedor terceiro expirar?

R: Repetir o passo 8 do tópico para fornecedores terceiros.


  • Aonde descobrimos o tempo de validade do token?

R: No cadastro de APIs (Adm > Configurações > Cadastro de API’s) configuramos o tempo no campo "Token expira (minutos)" que é calculado por minutos e definido por usuário.


  • Porque temos uma rotina para o Solus e outra para os fornecedores terceiros?

R: Quando deixamos cadastrado o token da Solus no “Configuração uso API-Solus” a web e módulos já tem previsto na programação o processo de autenticação para obter o token secundário, e também revalidam quando expirado.


  • O que é token primário?

R: É o token usado apenas na API login, para autenticar a geração do token secundário.


  • O que é token secundário?

R: É o token usado para autenticar no uso das rotas normais.


  • O que fazer quando for adicionado uma nova API?

R: Temos que refazer o processo a partir do passo 6 no primeiro fluxo (SOLUS)  e também no segundo fluxo (fornecedor) caso tenha fornecedor que usará essa nova API.


Aviso
titleAtenção

Documentação elaborada com base na versão vigente do sistema.



Editado por: Bruno Moura  

...