Token do Administrador
curl --request POST \
--url https://kong.api.toolzz.com.br/api/auth/login \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"institution_code": "<string>",
"password": "<string>"
}
'import requests
url = "https://kong.api.toolzz.com.br/api/auth/login"
payload = {
"email": "<string>",
"institution_code": "<string>",
"password": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', institution_code: '<string>', password: '<string>'})
};
fetch('https://kong.api.toolzz.com.br/api/auth/login', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://kong.api.toolzz.com.br/api/auth/login",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'institution_code' => '<string>',
'password' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://kong.api.toolzz.com.br/api/auth/login"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"institution_code\": \"<string>\",\n \"password\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://kong.api.toolzz.com.br/api/auth/login")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"institution_code\": \"<string>\",\n \"password\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/api/auth/login")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"institution_code\": \"<string>\",\n \"password\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAutorizacao
Token do Administrador
Gere o token de autorização que será usado nas suas requisições.
POST
/
api
/
auth
/
login
Token do Administrador
curl --request POST \
--url https://kong.api.toolzz.com.br/api/auth/login \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"institution_code": "<string>",
"password": "<string>"
}
'import requests
url = "https://kong.api.toolzz.com.br/api/auth/login"
payload = {
"email": "<string>",
"institution_code": "<string>",
"password": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', institution_code: '<string>', password: '<string>'})
};
fetch('https://kong.api.toolzz.com.br/api/auth/login', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://kong.api.toolzz.com.br/api/auth/login",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => '<string>',
'institution_code' => '<string>',
'password' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://kong.api.toolzz.com.br/api/auth/login"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"institution_code\": \"<string>\",\n \"password\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://kong.api.toolzz.com.br/api/auth/login")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"institution_code\": \"<string>\",\n \"password\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/api/auth/login")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"institution_code\": \"<string>\",\n \"password\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyParâmetros
string
required
E-mail do administrador da instituição.
string
required
Subdomínio da sua instituição (nome na url).
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:
- 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 - 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. - 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 - 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.
- Obtenção do Token:
Para obter um token de acesso, envie uma requisição POST para o endpoint/api/auth/logincom os seguintes dados:
Code Block Example
{
"email": "admin@instituicao.com",
"institution_code": "nome-subdominio",
"password": "sua_senha"
}
- 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..."
}
-
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 - 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.