Membros da Instituição
curl --request GET \
--url https://trialprod.app.toolzz.com.br/api/v1/reports/coursesimport requests
url = "https://trialprod.app.toolzz.com.br/api/v1/reports/courses"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://trialprod.app.toolzz.com.br/api/v1/reports/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://trialprod.app.toolzz.com.br/api/v1/reports/courses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://trialprod.app.toolzz.com.br/api/v1/reports/courses"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://trialprod.app.toolzz.com.br/api/v1/reports/courses")
.asString();require 'uri'
require 'net/http'
url = URI("https://trialprod.app.toolzz.com.br/api/v1/reports/courses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"current_page": 123,
"from": 123,
"last_page": 123,
"to": 123,
"total": 123,
"data": [
{
"id": 123,
"title": "<string>",
"imageUrl": "<string>",
"classrooms": [
{
"id": 123,
"schoolId": 123,
"title": "<string>",
"code": "<string>"
}
]
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
]
}
}
}Relatorios
Membros da Instituição
Esta API é destinada à gestão de membros, fornecendo informações detalhadas sobre os usuários.
GET
/
api
/
v1
/
reports
/
courses
Membros da Instituição
curl --request GET \
--url https://trialprod.app.toolzz.com.br/api/v1/reports/coursesimport requests
url = "https://trialprod.app.toolzz.com.br/api/v1/reports/courses"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://trialprod.app.toolzz.com.br/api/v1/reports/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://trialprod.app.toolzz.com.br/api/v1/reports/courses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://trialprod.app.toolzz.com.br/api/v1/reports/courses"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://trialprod.app.toolzz.com.br/api/v1/reports/courses")
.asString();require 'uri'
require 'net/http'
url = URI("https://trialprod.app.toolzz.com.br/api/v1/reports/courses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"current_page": 123,
"from": 123,
"last_page": 123,
"to": 123,
"total": 123,
"data": [
{
"id": 123,
"title": "<string>",
"imageUrl": "<string>",
"classrooms": [
{
"id": 123,
"schoolId": 123,
"title": "<string>",
"code": "<string>"
}
]
}
],
"links": {
"first": "<string>",
"last": "<string>",
"prev": "<string>",
"next": "<string>"
},
"meta": {
"current_page": 123,
"from": 123,
"last_page": 123,
"path": "<string>",
"per_page": 123,
"to": 123,
"total": 123,
"links": [
{
"url": "<string>",
"label": "<string>",
"active": true
}
]
}
}
}Parâmetros
string
Especifica o número da página de resultados a ser retornada.
string
Define o número de cursos a serem exibidos por página nos resultados da consulta.
Este endpoint funcionará corretamente apenas se o domínio da sua instituição for informado manualmente na URL, caso contrário, o endpoint poderá falhar ou retornar um erro de validação.
Segurança
Para acessar este endpoint, é necessário enviar um token de acesso válido através do cabeçalho de autorização (Authorization) da requisição. Além disso, a API é protegida por outras medidas de segurança para garantir a proteção dos dados dos usuários.Descrição da Resposta
Abaixo está um exemplo da resposta retornada por este endpoint.object
Contém a listagem paginada de cursos com suas respectivas turmas.
Show properties
Show properties
number
Página atual da listagem.
number
Índice do primeiro item na página atual.
number
Número total de páginas disponíveis.
number
Índice do último item na página atual.
number
Quantidade total de cursos listados.
array
Lista de cursos com dados relacionados.
Show items
Show items
number
Identificador único do curso.
string
Título do curso (ex: “Introdução à Astronomia”).
string
URL da imagem de capa do curso.
object
Links de paginação.
Show properties
Show properties
string
URL para a primeira página (ex: https://api.exemplo.com/courses?page=1).
string
URL para a última página (ex: https://api.exemplo.com/courses?page=3).
string
URL da página anterior (pode ser null).
string
URL da próxima página.
object
Metadados adicionais da paginação.
Show properties
Show properties
number
Número da página atual (ex: 1).
number
Índice inicial da listagem (ex: 1).
number
Última página da listagem (ex: 3).
string
Caminho base da API (ex: https://api.exemplo.com/courses).
number
Quantidade de itens por página (ex: 20).
number
Último índice da página atual (ex: 20).
number
Total de itens disponíveis (ex: 46).