Criar usuário em várias escolas
curl --request POST \
--url https://kong.api.toolzz.com.br/api/users \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"name": "<string>",
"schools": [
123
],
"permission": 123,
"cpf": "<string>",
"phone": "<string>",
"birth_date": "<string>",
"password": "<string>"
}
'import requests
url = "https://kong.api.toolzz.com.br/api/users"
payload = {
"email": "<string>",
"name": "<string>",
"schools": [123],
"permission": 123,
"cpf": "<string>",
"phone": "<string>",
"birth_date": "<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>',
name: '<string>',
schools: [123],
permission: 123,
cpf: '<string>',
phone: '<string>',
birth_date: '<string>',
password: '<string>'
})
};
fetch('https://kong.api.toolzz.com.br/api/users', 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/users",
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>',
'name' => '<string>',
'schools' => [
123
],
'permission' => 123,
'cpf' => '<string>',
'phone' => '<string>',
'birth_date' => '<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/users"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"schools\": [\n 123\n ],\n \"permission\": 123,\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<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/users")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"schools\": [\n 123\n ],\n \"permission\": 123,\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"password\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/api/users")
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 \"name\": \"<string>\",\n \"schools\": [\n 123\n ],\n \"permission\": 123,\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"password\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"ra": "<string>",
"img_perfil": "<string>",
"nome_completo": "<string>",
"data_nascimento": "<string>",
"cpf": "<string>",
"rg": "<string>",
"telefone": "<string>",
"ocupacao": "<string>",
"genero": "<string>",
"descricao": "<string>",
"escola_id": 123,
"permissao": "<string>",
"ultima_atividade": "<string>",
"trial": 123,
"status_id": 123,
"name": "<string>",
"email": "<string>",
"terms": "<string>",
"privilegio_id": "<string>",
"uuid": "<string>",
"updated_at": "<string>",
"created_at": "<string>",
"id": 123
}
}Usuarios
Criar usuário em várias escolas
Cadastre novos alunos no Toolzz em uma ou mais escolas da sua instituição
POST
/
api
/
users
Criar usuário em várias escolas
curl --request POST \
--url https://kong.api.toolzz.com.br/api/users \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"name": "<string>",
"schools": [
123
],
"permission": 123,
"cpf": "<string>",
"phone": "<string>",
"birth_date": "<string>",
"password": "<string>"
}
'import requests
url = "https://kong.api.toolzz.com.br/api/users"
payload = {
"email": "<string>",
"name": "<string>",
"schools": [123],
"permission": 123,
"cpf": "<string>",
"phone": "<string>",
"birth_date": "<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>',
name: '<string>',
schools: [123],
permission: 123,
cpf: '<string>',
phone: '<string>',
birth_date: '<string>',
password: '<string>'
})
};
fetch('https://kong.api.toolzz.com.br/api/users', 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/users",
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>',
'name' => '<string>',
'schools' => [
123
],
'permission' => 123,
'cpf' => '<string>',
'phone' => '<string>',
'birth_date' => '<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/users"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"schools\": [\n 123\n ],\n \"permission\": 123,\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<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/users")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"name\": \"<string>\",\n \"schools\": [\n 123\n ],\n \"permission\": 123,\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"password\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://kong.api.toolzz.com.br/api/users")
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 \"name\": \"<string>\",\n \"schools\": [\n 123\n ],\n \"permission\": 123,\n \"cpf\": \"<string>\",\n \"phone\": \"<string>\",\n \"birth_date\": \"<string>\",\n \"password\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"ra": "<string>",
"img_perfil": "<string>",
"nome_completo": "<string>",
"data_nascimento": "<string>",
"cpf": "<string>",
"rg": "<string>",
"telefone": "<string>",
"ocupacao": "<string>",
"genero": "<string>",
"descricao": "<string>",
"escola_id": 123,
"permissao": "<string>",
"ultima_atividade": "<string>",
"trial": 123,
"status_id": 123,
"name": "<string>",
"email": "<string>",
"terms": "<string>",
"privilegio_id": "<string>",
"uuid": "<string>",
"updated_at": "<string>",
"created_at": "<string>",
"id": 123
}
}Parâmetros
string
required
E-mail do novo usuário.
string
required
Nome do novo usuário.
number[]
required
ID da escola ou escolas, na qual deseja cadastrar este novo usuário.
int
required
Permissão do novo usuário. Valores permitidos: 2, 3, 4, 5.
string
CPF do novo usuário.
string
Telefone do novo usuário.
date
Data de nascimento do novo usuário.
string
Senha do novo usuário.
Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:
- E-mail
obrigatório: O endereço de e-mail do novo estudante a ser adicionado. - Nome
obrigatório: O nome completo do estudante que está sendo incluído. - Escolas
obrigatório: Caso pertinente, é possível vincular o estudante a uma ou mais escolas.
Descrição da Resposta
Abaixo está um exemplo da resposta retornada por este endpoint.object
Detalhes do perfil do usuário.
Show properties
Show properties
string
Número de registro (pode ser nulo).
string
Nome do arquivo da imagem de perfil.
string
Nome completo do usuário.
string
Data de nascimento (pode ser nula).
string
CPF (Cadastro de Pessoa Física) (pode ser nulo).
string
RG (Registro Geral) (pode ser nulo).
string
Telefone de contato (pode ser nulo).
string
Ocupação do usuário (pode ser nula).
string
Gênero (pode ser nulo).
string
Descrição adicional (pode ser nula).
number
Identificador único da escola associada.
string
Nível de permissão do usuário.
string
Data e hora da última atividade.
number
Indica se o usuário está em período de teste (0 = Não, 1 = Sim).
number
Identificador de status do usuário.
string
Nome do usuário.
string
Endereço de e-mail do usuário.
string
Indica se o usuário aceitou os termos.
string
Identificador do nível de privilégio.
string
Identificador Universal Único (UUID) do usuário.
string
Data e hora da última atualização do perfil.
string
Data e hora da criação do perfil.
number
Identificador único do usuário.