Versões comparadas

Versão Versão antiga 5 Nova versão 6
Alterações feitas por

Solus (Unlicensed)

Solus (Unlicensed)

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.
Comentário: Adicionado o novo recurso "Vincular Token Solus".

...

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 "

Expandir
titleUso das APIs - SOLUS
" para conseguirmos fazer o "Uso das APIs - Terceiros".Uso das APIs - SOLUS


Expandir
title
Versão 08/2021

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

Image Modified

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


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

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

Image Modified


3 - Vincular o operador SOLUS em todas as APIs.

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

Image Modified


4 - Obtendo o accessToken do usuário SOLUS.

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

Image Modified



5 - Usararotainstallparagerarotokenprimário.

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

Image Modified


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

Image Modified


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

Image Modified


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

Image Modified


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

Image Modified


6 - Cadastrartokenretornadodarotainstallem"ConfiguraçãousoAPI-Solus".

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

Image Modified



Expandir
titleVersão 11/2021 ou superior

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

Image Added

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


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

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

Image Added


3 - Vincular o operador SOLUS em todas as APIs.

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

Image Added


4 - Vincular o token Solus.

4.1 - Clicamos no botão "Vincular Token Solus";

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

Image AddedObs: Esse botão substitui os passos 4, 5 e 6 presentes no mesmo fluxo da versão 08/2021.


4.2 - Será apresentado uma mensagem de conclusão;

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

Image Added


4.3 - Acessamos a "Configuração uso API-Solus" para certificarmos que houve o preenchimento.

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

Image Added




Expandir
titleUso das APIs - Terceiros

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

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


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

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


3 - 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


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

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


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

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


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


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


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


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


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

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


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


6.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 6 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 4 no primeiro fluxo (SOLUS)  e também no segundo fluxo (fornecedor) caso tenha fornecedor que usará essa nova API.


  • Porque temos duas rotas para chegar no token secundário no fluxo de fornecedor?

R: Por motivos de segurança. Caso o acesstoken usado na primeira rota (install) seja exposto após a sua utilização, não trará riscos, pois só pode ser usado uma única vez.


Aviso
titleAtenção

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


Editado por: Bruno Moura  

...