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