curl --request GET \
--url https://api.useweve.com/v1/clubs/{clubId}/students \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useweve.com/v1/clubs/{clubId}/students"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useweve.com/v1/clubs/{clubId}/students', 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://api.useweve.com/v1/clubs/{clubId}/students",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.useweve.com/v1/clubs/{clubId}/students"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.useweve.com/v1/clubs/{clubId}/students")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useweve.com/v1/clubs/{clubId}/students")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "jsmith@example.com",
"verified": true,
"has_password": true,
"anonymized": true,
"comments_muted": true,
"created_at": "2023-11-07T05:31:56Z",
"document": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"recent_lessons": 123,
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"has_access": true,
"engagement": "cold"
}
],
"total": 123,
"engagement": {
"cold": 123,
"warm": 123,
"active": 123,
"engaged": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Listar alunos
Nome e e-mail; exige administrar o club.
curl --request GET \
--url https://api.useweve.com/v1/clubs/{clubId}/students \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useweve.com/v1/clubs/{clubId}/students"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useweve.com/v1/clubs/{clubId}/students', 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://api.useweve.com/v1/clubs/{clubId}/students",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://api.useweve.com/v1/clubs/{clubId}/students"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.useweve.com/v1/clubs/{clubId}/students")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useweve.com/v1/clubs/{clubId}/students")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "jsmith@example.com",
"verified": true,
"has_password": true,
"anonymized": true,
"comments_muted": true,
"created_at": "2023-11-07T05:31:56Z",
"document": "<string>",
"last_seen_at": "2023-11-07T05:31:56Z",
"recent_lessons": 123,
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"has_access": true,
"engagement": "cold"
}
],
"total": 123,
"engagement": {
"cold": 123,
"warm": 123,
"active": 123,
"engaged": 123
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Token OPACO de sessão de quem administra, emitido por
/v1/auth/admin/sign-in e verificado contra a nossa tabela — o mesmo
desenho do studentSession, para a outra identidade.
É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o
studentSession; uma rota consumida pelos dois declara os dois
esquemas, e o middleware aceita qualquer um deles. As duas credenciais
são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em
que cada uma existe.
O dashboard o guarda em cookie httpOnly, que o BFF troca pelo
Authorization a cada chamada.
Path Parameters
Id público da organização — o mesmo que GET /v1/me devolve em
organization_id.
Na URL o recurso se chama club; no contrato e no domínio, organization.
A divergência é deliberada: clubs é a palavra do produto, e a URL é o que
as pessoas leem.
É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer.
O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso.
Query Parameters
200Deixa de fora as contas de aluno de quem ADMINISTRA o club — as que
POST /v1/clubs/{clubId}/classroom-session cria para a própria
pessoa ver o classroom. Elas não são matrícula de ninguém, e é o
que a busca de "entrar como aluno" pede.
O filtro mora aqui, e não na tela, porque a diferença é uma coluna
que o contrato não conta: StudentSummary não diz quem, entre os
alunos, também administra o club.
Traz também as contas anonimizadas a pedido (anonymized). Fora
delas por padrão: numa lista de pessoas, uma conta removida é uma
lápide com nome de ninguém. Quem procura uma conta específica no
suporte liga o filtro.
O recorte da tela de Membros. at_risk é o engagement frio —
quem não aparece há mais de uma semana; new é quem se cadastrou
nos últimos sete dias; completed é quem já terminou ao menos UM
curso inteiro (todas as aulas publicadas dele).
Um curso, e não tudo o que tem acesso: quem assina o club inteiro nunca terminaria "tudo", e a aba ficaria vazia para sempre.
all, at_risk, new, completed Só quem tem esta tag.
Filtra por quando a pessoa esteve no classroom pela última vez.
stale inclui quem nunca entrou: a pergunta é de quem não se sabe
nada há uma semana, e nunca visto é o caso extremo dela.
any, last_7_days, last_30_days, stale 1 <= x <= 100x >= 1Response
A página pedida
Show child attributes
Show child attributes
Quantos alunos o recorte tem, além desta página.
Quantas pessoas em cada faixa. Mede o CLUB inteiro, não o recorte pedido: sob a aba "Em risco" um termômetro do recorte diria sempre 100% frio, que é a pergunta respondendo a si mesma. Contas removidas ficam de fora.
Show child attributes
Show child attributes