Autenticação

Obtendo um token de acesso

Para obter um token de acesso, chame POST /api/authorize/auth/ com credenciais (que você obteve conosco) contendo o email e a senha necessários no corpo da solicitação. O endereço do host deve ser o endereço da API (o mesmo que você também obteve conosco).

{
	"credentials": {
		"email": "{{user_email}}", // seu login
		"password": "{{user_password}}" // sua senha
	}
}

A resposta bem-sucedida retornará um par de tokens:access_token e expire_token.

access_token é uma chave que concede acesso aos recursos do sistema. Para acessar um recurso, é necessário adicionar seu access_token ao cabeçalho.

headers = {‘ X-Forensic-Access-Token’: <access_token>}

access_token tem tempo limitado; os limites dependem do tipo de conta.

• contas de serviço – OZ_SESSION_LONGLIVE_TTL (5 anos por padrão),

• outras contas – OZ_SESSION_TTL (15 minutos por padrão).

expire_token é o token que pode ser usado para renovar seu access token, se necessário.

Extensão automática da sessão

Se o valor deexpire_date > data atual, o valor da sessão atualexpire_date é definido como data atual + período de tempo que é definido conforme mostrado acima (dependendo do tipo de conta).

Renovação de token

Para renovaraccess_token e expire_token, chame POST /api/authorize/refresh/. Adicionar expire_token no corpo da solicitação e X-Forensic-Access-Token no cabeçalho.

{
    "expire_token": "{{expire_token}}"
}

Em caso de sucesso, você receberá um novo par de access_token e expire_token. O par "antigo" será excluído na primeira autenticação com os tokens renovados.

Erros

Código de erro	Mensagem de erro	O que causou o erro
400	Não foi possível localizar o campo para key_path expire_token nos dados de dicionário fornecidos	expire_token não foram encontrados no corpo da solicitação
401	Sessão não encontrada	A sessão com expire_token que você informou não existe.
403	Você não tem acesso para renovar esta sessão	O usuário que faz a solicitação não é esteexpire_token proprietário da sessão.