POST
/
api
/
auth
/
login
curl --request POST \
  --url https://kong.api.toolzz.com.br/api/auth/login \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "institution_code": "<string>",
  "password": "<string>"
}'

​
Parâmetros

​
email
string
required

E-mail do administrador da instituição.

​
institution_code
string
required

Subdomínio da sua instituição (nome na url).

​
password
string
required

Senha de login do administrador da instituição.

Antes de começar, é necessário ter uma conta de administrador na plataforma Toolzz. Caso você ainda não possua uma, acesse o site da plataforma e siga as instruções para criar uma conta. Isso lhe dará as credenciais de login necessárias para se autenticar nas APIs

​
Acessar o Endpoint de Login:

  1. Para obter um token de acesso, você precisa enviar uma solicitação POST para o endpoint de login da API. O endpoint padrão para login é /api/auth/login
  2. Após enviar a solicitação de login, você receberá uma resposta do servidor. O token de acesso estará incluído na resposta como access_token. Esse token será usado para autenticar-se em outras solicitações às APIs da Plataforma Toolzz.
  3. Para acessar os endpoints protegidos nas APIs, você deve incluir o token de acesso no cabeçalho de autorização de suas solicitações. O cabeçalho deve ser configurado da seguinte forma: Authorization: Bearer SEU_TOKEN_AQUI
  4. Agora que você possui um token de acesso válido, pode usá-lo para realizar solicitações aos endpoints das APIs que fornecem acesso aos dados e funcionalidades da instituição à qual você está vinculado.
Lembre-se de manter sempre suas credenciais e tokens de acesso seguros. Evite compartilhá-los e armazene-os de forma segura.
  1. Obtenção do Token:
    Para obter um token de acesso, envie uma requisição POST para o endpoint /api/auth/login com os seguintes dados:
Code Block Example
{
  "email": "admin@instituicao.com",
  "institution_code": "nome-subdominio",
  "password": "sua_senha"
}
  1. Resposta da API: Após a requisição bem-sucedida, você receberá um token de acesso no campo access_token da resposta. Exemplo:
Code Block Example
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

  1. Autenticação em Endpoints Protegidos: Para acessar os endpoints protegidos nas APIs, você deve incluir o token de acesso no cabeçalho de autorização de suas solicitações. O cabeçalho deve ser configurado da seguinte forma: Authorization: Bearer SEU_TOKEN_AQUI

  2. Acesso às Funcionalidades: Agora que você possui um token de acesso válido, pode usá-lo para realizar solicitações aos endpoints das APIs que fornecem acesso aos dados e funcionalidades da instituição à qual você está vinculado.