Como autenticar na API Oobj?

Nesta página você encontra os procedimentos necessários para criar um aplicativo no Monitor Oobj, e informações sobre como utilizar as credenciais fornecidas pelo aplicativo para iniciar uma sessão autenticada.

---

Visão geral

O processo de autenticação na API REST Oobj é composto por dois procedimentos:

1. Criar um Aplicativo no Monitor Oobj;
2. Iniciar uma sessão autenticada na API.

Ao criar um Aplicativo no Monitor Oobj, você recebe um token (username) e um secret (password) para enviar como parâmetro ao endpoint /authenticate.

Com o sucesso da requisição ao endpoint /authenticate, você recebe um x-auth-token que deverá ser enviado no cabeçalho (header) de qualquer requisição feita para a API.

---

Pré-requisitos

• Para criar o aplicativo é necessário um usuário de acesso ao Monitor Oobj, com perfil de Responsável pela Conta.

DICA

O cadastro do Aplicativo no Monitor pode ser feito pela equipe Oobj. Se precisar entre em contato com o suporte técnico da Oobj. Após o retorno do suporte, pule para a etapa Iniciar uma sessão autenticada na API 😉

---

Criar um Aplicativo no Monitor Oobj

1. No Monitor, acesse o menu Administração > Contas;

2. Clique na opção Editar Conta da conta que deseja adicionar o Aplicativo;

3. Vá para a aba Aplicativos e clique em Novo aplicativo;

4. Selecione o Tipo Personalizado e informe o Nome do aplicativo;

Dica

Crie um Aplicativo para cada módulo com o qual você irá trabalhar na API. Por exemplo: "Emissor NFe", "Recebimento NFe", etc. Dessa forma, caso algum serviço apresente instabilidade, você não irá comprometer toda a sua operação.

5. Clique em Gerar Token e Secret;

6. Clique em Salvar para criar o Aplicativo;

7. Por fim, de volta à aba Aplicativos, clique em Salvar, no canto inferior esquerdo da página.

---

Iniciar uma sessão autenticada na API

Agora que já possui o token e o secret, você pode iniciar uma sessão de trabalho autenticada na API.

Observação

Consulte a documentação Referência de API para realizar testes de requisição.

1. Realize uma requisição tipo POST ao endpoint gerar um token de acesso;

   [URL_BASE]/authenticate

2. Envie no corpo da requisição (request body) o token (username) e o secret (password) gerados pelo Aplicativo do Monitor Oobj;

   {
    "password": "string",
    "username": "string"
   }

3. Caso esteja tudo certo com a sua requisição, o retorno será um x-auth-token, como este:

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

4. Pronto! Você está em uma sessão autenticada na API REST Oobj. Envie o x-auth-token, sem as aspas, no cabeçalho de todas as requisições que realizar para a API.

Atenção

O x-auth-token expira depois de 30 (trinta) minutos de inatividade. Ou seja, caso você faça requisições constantes para a API, sem ultrapassar esse limite de tempo, poderá utilizar o mesmo x-auth-token. Caso contrário, deverá refazer o procedimento de Autenticação.