Matrículas de aluno

curl --request GET \
  --url https://kong.api.toolzz.com.br/api/users/courses \
  --header 'Content-Type: application/json' \
  --data '
{
  "institution_code": "<string>"
}
'

import requests

url = "https://kong.api.toolzz.com.br/api/users/courses"

payload = { "institution_code": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({institution_code: '<string>'})
};

fetch('https://kong.api.toolzz.com.br/api/users/courses', 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/courses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'institution_code' => '<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/courses"

	payload := strings.NewReader("{\n  \"institution_code\": \"<string>\"\n}")

	req, _ := http.NewRequest("GET", 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.get("https://kong.api.toolzz.com.br/api/users/courses")
  .header("Content-Type", "application/json")
  .body("{\n  \"institution_code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://kong.api.toolzz.com.br/api/users/courses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"institution_code\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": 123,
    "uuid": "<string>",
    "name": "<string>",
    "email": "<string>",
    "cpf": "<string>",
    "enrollment_start_date": "<string>",
    "enrollment_end_date": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "ultima_atividade": "<string>",
    "school": {
      "id": 123,
      "titulo": "<string>"
    },
    "address": {
      "id": 123,
      "address_id": 123,
      "cep": "<string>",
      "uf": "<string>",
      "cidade": "<string>",
      "bairro": "<string>",
      "logradouro": "<string>",
      "numero": "<string>",
      "complemento": "<string>"
    },
    "custom_form": [
      {
        "enunciado": "<string>",
        "pergunta_id": 123,
        "resposta": "<string>"
      }
    ],
    "institution": [
      {
        "id": 123,
        "subdomain": "<string>",
        "titulo": "<string>"
      }
    ]
  }
}

GET

api

users

courses

Matrículas de aluno

curl --request GET \
  --url https://kong.api.toolzz.com.br/api/users/courses \
  --header 'Content-Type: application/json' \
  --data '
{
  "institution_code": "<string>"
}
'

import requests

url = "https://kong.api.toolzz.com.br/api/users/courses"

payload = { "institution_code": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({institution_code: '<string>'})
};

fetch('https://kong.api.toolzz.com.br/api/users/courses', 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/courses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'institution_code' => '<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/courses"

	payload := strings.NewReader("{\n  \"institution_code\": \"<string>\"\n}")

	req, _ := http.NewRequest("GET", 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.get("https://kong.api.toolzz.com.br/api/users/courses")
  .header("Content-Type", "application/json")
  .body("{\n  \"institution_code\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://kong.api.toolzz.com.br/api/users/courses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"institution_code\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": 123,
    "uuid": "<string>",
    "name": "<string>",
    "email": "<string>",
    "cpf": "<string>",
    "enrollment_start_date": "<string>",
    "enrollment_end_date": "<string>",
    "created_at": "<string>",
    "updated_at": "<string>",
    "ultima_atividade": "<string>",
    "school": {
      "id": 123,
      "titulo": "<string>"
    },
    "address": {
      "id": 123,
      "address_id": 123,
      "cep": "<string>",
      "uf": "<string>",
      "cidade": "<string>",
      "bairro": "<string>",
      "logradouro": "<string>",
      "numero": "<string>",
      "complemento": "<string>"
    },
    "custom_form": [
      {
        "enunciado": "<string>",
        "pergunta_id": 123,
        "resposta": "<string>"
      }
    ],
    "institution": [
      {
        "id": 123,
        "subdomain": "<string>",
        "titulo": "<string>"
      }
    ]
  }
}

Parâmetros

string

required

Pode ser “email” ou “id”.

string

required

Valor de acordo com a opção “by”. Pode ser o e-mail ou o ID de um usuário.

string

required

Subdomínio da sua instituição, conforme aparece na URL original.

Antes de utilizar este endpoint, certifique-se de possuir os seguintes parâmetros disponíveis:

by obrigatório: Uma flag que define o tipo de busca que você deseja realizar. Os valores válidos são email ou cpf.
value obrigatório: O valor do e-mail ou CPF que você deseja pesquisar.
institution_code obrigatório: Subdomínio da sua instituição, conforme aparece na URL original.

Descrição da Resposta

Abaixo está um exemplo da resposta retornada por este endpoint.

object

Detalhes do perfil do usuário.

Show properties

number

Identificador único do usuário.

string

Identificador único universal (UUID) do usuário.

string

Nome completo do usuário.

string

Endereço de e-mail do usuário.

string

CPF (Cadastro de Pessoa Física).

string

Data de início da matrícula do aluno (formato YYYY-MM-DD). Ignorada se o curso não suportar esse parâmetro.

string

Data final da matrícula do aluno (formato YYYY-MM-DD). Gravada como matriculas.data_validade.

string

Data e hora de criação do usuário.

string

Data e hora da última atualização do perfil.

string

Data e hora da última atividade do usuário.

object

Informações da escola.

Show properties

number

Identificador único da escola.

string

Nome da escola.

object

Detalhes do endereço do usuário.

Show properties

number

Identificador único do endereço.

number

Referência para o endereço.

string

Código postal (CEP).

string

Sigla do estado.

string

Nome da cidade.

string

Nome do bairro.

string

Nome da rua.

string

Número da residência ou apartamento.

string

Complemento do endereço (ex.: apartamento, andar).

array

Lista de perguntas e respostas personalizadas.

Show items

string

Enunciado da pergunta.

number

Identificador único da pergunta.

string

Resposta do usuário à pergunta.

array

Lista de instituições associadas ao usuário.

Show items

number

Identificador único da instituição.

string

Subdomínio da instituição.

string

Nome da instituição.

A data de início enrollment_start_date será ignorada para cursos que não utilizam essa configuração. Só é aplicável a componentes específicos da plataforma.

⚠️ Validações

Se enrollment_end_date for anterior a ‘enrollment_start_date’, a requisição será rejeitada com erro:

{
  "error": "End date cannot be previous to Start date"
}

Segurança

Para acessar este endpoint, é necessário enviar um token de acesso válido no cabeçalho de autorização (Authorization) da requisição. Além disso, a API conta com outras medidas de segurança para proteger os dados dos usuários.

Toolzz LMS API reference

Webhooks

Matrículas de aluno

Parâmetros

Descrição da Resposta

⚠️ Validações

Segurança

​Parâmetros

​Descrição da Resposta

​⚠️ Validações

​Segurança

Parâmetros

Descrição da Resposta

⚠️ Validações

Segurança