Autenticação na API Rest

A Autenticação na API Rest permite que se obtenha autorização para se comunicar e realizar Emissão, Recebimento e Importação de de DFes, entre outras ações relacionadas a DF-es e Empresas. Antes de utilizar qualquer um dos serviços da API, o usuário deve obter um x-auth-token.

O x-auth-token é uma sessão de trabalho e para obtê-la, é preciso ter um Token (usuário) e um Secret (senha), que são fornecidos pelo Suporte Oobj.

 

 

Existem três Endpoints para o serviço de Autenticação e para cada um, há uma URL específica.

 

Criar Nova Sessão (POST)

Para se criar Nova Sessão será utilizado o Token e o Secret, fornecidos pelo Suporte Oobj. Quando feito a requisição, será gerado um x-auth-token, que permitirá o usuário realizar as demais operações.

O token gerado expirará dentro de 30 minutos quando não houver nenhuma interação neste tempo.

A URL é construída da seguinte forma:

http:// ou https:// + /endereço da API Rest + /authenticate

 

http://rest-teste.oobj.com.br/authenticate

 

O Token e Secret devem ser passados como parâmetros e como resposta ao realizar a requisição, será devolvido o x-auth-token.

Exemplo de um x-auth-token após a requisição. Deve utilizar o token sem as aspas:

 

{
  "token": "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiI3Yjc2OTg1ZGQ2MTNhOWVlYTFiN2RmZTNiZjRhMTRiZiIsImF1ZCI6IndlYiIsImV4cCI6MTYyOTI5MDcwNiwiaWF0IjoxNjI5Mjg4OTA2fQ.-Dj91d6fBZYcZpy1-zKzohAWd5dgW2CAS5BBfwGilemUYcOVDm8CnrDJHbwsFyixI5ohphy-65fqeobXkimtCg"
}

  

Informações da Sessão (GET)

Ao obter autorização (x-auth-token) há qualquer momento, o usuário poderá verificar se essa sessão continua ativa para realizar operações com a API.

http:// ou https:// + /endereço da API Rest + /me

 

http://rest-teste.oobj.com.br/me

 

Abaixo um exemplo do retorno com as informações da sessão. Quando as informações no fim da requisição estiverem "true", significa que a sessão está ativa:

 

{
  "password": "*******",
  "username": "7b76985dd613a9eea1b7dfe3bf4a14bf",
  "authorities": [
    {
      "authority": "USER"
    }
  ],
  "accountNonExpired": true,
  "accountNonLocked": true,
  "credentialsNonExpired": true,
  "enabled": true
}

 

Atualizar o Token de Acesso (GET)

 

A sessão de trabalho criada será removida após 30 minutos de inatividade. Atingido esse tempo, é preciso criar uma Nova Sessão e obter um novo x-auth-token. Porém, é possível apenas renovar a sessão antes que expire, utilizando a requisição refresh, passando o token já criado.

 

A URL é construída da seguinte forma:

 

http:// ou https:// + /endereço da API Rest + /refresh

 

http://rest-teste.oobj.com.br/refresh

 

Para realizar testes com a API Rest, e ter mais detalhes sobre a Autenticação, acesse a documentação completa através do link: http://rest-teste.oobj.com.br/swagger-ui.html#!/Autenticacao

0 (0)
Avaliação do Artigo (Nenhum voto)
Avaliar esse artigo
Anexos
Não há anexos para este artigo.
Artigos Relacionados RSS Feed
Gerenciamento de Empresas na API Rest
Visualizado 1241 vezes desde 16/03/2018
API REST: Ano contido no documento não é o mesmo do informado no serviço - Como resolver?
Visualizado 1417 vezes desde 08/01/2019
Geração de DADFe sem valor fiscal na API Rest
Visualizado 772 vezes desde 25/05/2020
Consulta Cadastro Centralizado de Contribuinte - Consulta Cadastro API Rest
Visualizado 1062 vezes desde 14/01/2021
Inutilização de Numeração na API Rest
Visualizado 2485 vezes desde 16/03/2018
Consultar MDF-e não encerrado via API Rest
Visualizado 399 vezes desde 23/08/2021
Consultar Base de Conhecimento (BC) via API Rest
Visualizado 223 vezes desde 03/08/2021
Criar Aplicativo no Monitor Oobj
Visualizado 1675 vezes desde 12/04/2018
Emissão de DFes na API Rest
Visualizado 3801 vezes desde 13/03/2018
Como funciona o processo de emissão na API Rest?
Visualizado 2498 vezes desde 06/08/2019
Comentários
Nome
Email
Código de Segurança Security Code
Não há comentários para este artigo. Seja o primeiro a postar um comentário.