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.

A URL é construída da seguinte forma:

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

 

http://rest.oobj-dfe.com.br/session

 

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

 

Encerrar Sessão (DELETE)

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, caso queira encerrar sua sessão após concluir suas operações, basta utilizar esse Endpoint.

A URL é construída da seguinte forma: 

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

 

http://rest.oobj-dfe.com.br/session

 

Como pôde perceber, a URL do Endpoint para Encerrar Sessão é o mesmo da URL para criar uma Nova Sessão. A diferença está nos parâmetros que informa. No Endpoints para se Encerrar a Sessão será informado como parâmetro o x-auth-token obtido no Endpoint para se Criar Nova Sessão.

 

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.oobj-dfe.com.br/me

 

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.oobj-dfe.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
Integração API Rest
Visualizado 659 vezes desde 09/03/2018
Emissão de DFes na API Rest
Visualizado 535 vezes desde 13/03/2018
Emissão de Eventos Fiscais na API Rest
Visualizado 397 vezes desde 16/03/2018
Inutilização de Numeração na API Rest
Visualizado 400 vezes desde 16/03/2018
Importação e Conciliação de DFes na API Rest
Visualizado 318 vezes desde 16/03/2018
Recebimento de Documentos Fiscais via API Rest
Visualizado 279 vezes desde 16/03/2018
Gerenciamento de Empresas na API Rest
Visualizado 256 vezes desde 16/03/2018
Manutenção de CSC (Código de Segurança do Contribuinte) na API Rest
Visualizado 772 vezes desde 16/03/2018
Criar Aplicativo no Monitor Oobj
Visualizado 197 vezes desde 12/04/2018
Configurar MDe na Api Rest
Visualizado 55 vezes desde 27/09/2018
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.