API Reference

Olá, abaixo vamos mostrar como realizar a autenticação do seu usuário:

  • Deve realizar uma requisição usando o método POST no endpoint

O Body que deve colocar neste POST irá depender do TIPO de usuário. Além disso quando for autenticar o usuário deve colocar o seguinte header:

KeyValue
X-Credential-Typeauthenticate
Content-Typeapplication/json

Se for usuário do tipo APLICAÇÃO deve informar:

{  
    "email":"String",  
    "senha":"String"  
}

Caso seja um usuário do tipo USUÁRIO deverá informar os dados da seguinte forma:

{  
    "email":"String",  
    "senha":"String",  
    "codigo_2fa_telefone":"String"  
}

📘

codigo_2fa_telefone:

Este é o código que deverá ser informado no primeiro acesso e quando o usuário for do tipo USUÁRIO. Caso seja do tipo APLICAÇÃO não será necessário informar o código 2fa.

Revalidação o token.

Após fazer o login no sistema, será necessário confirmar a autenticação novamente em até 15 minutos para manter o acesso ativo. Esse processo é chamado de revalidate.

Para isso, você deve enviar uma nova requisição usando o método POST para o endereço abaixo:

https://sandbox.sistematize.me:8443/api/v1/usuario/autenticar

Na prática, isso significa que você precisa repetir a solicitação de autenticação utilizando os mesmos dados fornecidos anteriormente. Esse passo garante que a sessão do usuário continue ativa e segura.

O Body para uma revalidação deve usar a seguinte estrutura:

{
    "id": "String",
    "token":"String"
}

O id deve ser o id do usuário. Já o token, deve ser o ultimo token retornado na ultima requisição.

Será necessário informar no header da requisição o valor revalidate na chave "X-Credential-Type":

KeyValue
X-Credential-Typerevalidate
Content-Typeapplication/json

📘

OBS:

Ao expirar o token, será necessário realizar uma nova solicitação na rota de autenticação, seguindo as instruções descritas acima.

Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!