Define o nome e o endereço do club no classroom
curl --request PATCH \
--url https://api.useweve.com/v1/clubs/{clubId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"logo_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"favicon_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"login_image_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"support_email": "<string>",
"member_theme_choice": true,
"support_phone": "<string>",
"accent_color": "<string>",
"slug": "<string>",
"name": "<string>"
}
'import requests
url = "https://api.useweve.com/v1/clubs/{clubId}"
payload = {
"logo_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"favicon_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"login_image_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"support_email": "<string>",
"member_theme_choice": True,
"support_phone": "<string>",
"accent_color": "<string>",
"slug": "<string>",
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
logo_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
favicon_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
login_image_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
support_email: '<string>',
member_theme_choice: true,
support_phone: '<string>',
accent_color: '<string>',
slug: '<string>',
name: '<string>'
})
};
fetch('https://api.useweve.com/v1/clubs/{clubId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'logo_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'favicon_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'login_image_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'support_email' => '<string>',
'member_theme_choice' => true,
'support_phone' => '<string>',
'accent_color' => '<string>',
'slug' => '<string>',
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.useweve.com/v1/clubs/{clubId}"
payload := strings.NewReader("{\n \"logo_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"favicon_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"login_image_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"support_email\": \"<string>\",\n \"member_theme_choice\": true,\n \"support_phone\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"slug\": \"<string>\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.useweve.com/v1/clubs/{clubId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"logo_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"favicon_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"login_image_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"support_email\": \"<string>\",\n \"member_theme_choice\": true,\n \"support_phone\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"slug\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useweve.com/v1/clubs/{clubId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"logo_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"favicon_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"login_image_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"support_email\": \"<string>\",\n \"member_theme_choice\": true,\n \"support_phone\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"slug\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"theme": "light",
"member_theme_choice": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"logo": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "video",
"download_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"favorite": true,
"usage_count": 123
},
"favicon": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "video",
"download_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"favorite": true,
"usage_count": 123
},
"login_image": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "video",
"download_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"favorite": true,
"usage_count": 123
},
"support_email": "<string>",
"support_phone": "<string>",
"slug": "<string>",
"accent_color": "#1d63d1"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Clubs
Nome e endereço do club
Renomeia o club e define o subdomínio em que o classroom atende. Com slug o endereço é exato; com name, derivado.
PATCH
/
v1
/
clubs
/
{clubId}
Define o nome e o endereço do club no classroom
curl --request PATCH \
--url https://api.useweve.com/v1/clubs/{clubId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"logo_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"favicon_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"login_image_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"support_email": "<string>",
"member_theme_choice": true,
"support_phone": "<string>",
"accent_color": "<string>",
"slug": "<string>",
"name": "<string>"
}
'import requests
url = "https://api.useweve.com/v1/clubs/{clubId}"
payload = {
"logo_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"favicon_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"login_image_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"support_email": "<string>",
"member_theme_choice": True,
"support_phone": "<string>",
"accent_color": "<string>",
"slug": "<string>",
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
logo_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
favicon_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
login_image_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
support_email: '<string>',
member_theme_choice: true,
support_phone: '<string>',
accent_color: '<string>',
slug: '<string>',
name: '<string>'
})
};
fetch('https://api.useweve.com/v1/clubs/{clubId}', 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}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'logo_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'favicon_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'login_image_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'support_email' => '<string>',
'member_theme_choice' => true,
'support_phone' => '<string>',
'accent_color' => '<string>',
'slug' => '<string>',
'name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://api.useweve.com/v1/clubs/{clubId}"
payload := strings.NewReader("{\n \"logo_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"favicon_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"login_image_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"support_email\": \"<string>\",\n \"member_theme_choice\": true,\n \"support_phone\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"slug\": \"<string>\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.patch("https://api.useweve.com/v1/clubs/{clubId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"logo_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"favicon_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"login_image_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"support_email\": \"<string>\",\n \"member_theme_choice\": true,\n \"support_phone\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"slug\": \"<string>\",\n \"name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useweve.com/v1/clubs/{clubId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"logo_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"favicon_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"login_image_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"support_email\": \"<string>\",\n \"member_theme_choice\": true,\n \"support_phone\": \"<string>\",\n \"accent_color\": \"<string>\",\n \"slug\": \"<string>\",\n \"name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"theme": "light",
"member_theme_choice": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"logo": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "video",
"download_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"favorite": true,
"usage_count": 123
},
"favicon": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "video",
"download_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"favorite": true,
"usage_count": 123
},
"login_image": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "video",
"title": "<string>",
"provider": "bunny_stream",
"status": "uploading",
"visibility": "private",
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"file_name": "<string>",
"mime": "<string>",
"size_bytes": 123,
"external_id": "<string>",
"error": "<string>",
"duration_seconds": 123,
"width": 123,
"height": 123,
"preview_url": "<string>",
"thumbnail_url": "<string>",
"folder_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "video",
"download_url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"favorite": true,
"usage_count": 123
},
"support_email": "<string>",
"support_phone": "<string>",
"slug": "<string>",
"accent_color": "#1d63d1"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"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.
Body
application/json
Ao menos um campo. slug define o endereço exatamente; name
renomeia o club e, na falta de slug, é a semente de um endereço
derivado. A marca (logo_media_id, favicon_media_id,
login_image_media_id), a cor (accent_color) e o suporte
(support_email, support_phone) e o tema (theme,
member_theme_choice) valem sozinhos e não tocam o endereço. Nulo
tira; ausente mantém.
A marca do club, da biblioteca de mídia. Nulo tira a marca.
O ícone da aba do navegador no classroom — uma imagem da biblioteca, de preferência quadrada. Nulo volta ao ícone padrão.
A imagem das telas de entrada do classroom — uma imagem da biblioteca. Nulo deixa a tela só com o formulário.
O e-mail de suporte ao aluno. Nulo (ou em branco) tira o contato.
Maximum string length:
254O tema base da área do aluno — o que vale para quem não escolheu outro
(ou para todos, sem member_theme_choice).
Available options:
light, dark Libera (ou tira) a troca de tema pelo aluno.
O telefone de suporte ao aluno, escrito como o club quiser mostrá-lo:
dígitos, espaço, +, -, ( e ). Nulo (ou em branco) tira o
contato.
Maximum string length:
32A cor do club no classroom, em hex de seis dígitos. Nulo volta à cor do classroom. Como a marca, vale sozinha no corpo.
Pattern:
^#[0-9a-fA-F]{6}$Rótulo de DNS: minúscula, dígito e hífen, sem hífen nas pontas. Nomes que o produto reserva são recusados com o mesmo código de um slug mal formado — dizer qual é reservado entregaria a lista.
Required string length:
1 - 63O nome do club. Sem slug no corpo, é dele que o endereço
derivado sai — renomear sozinho troca o endereço junto.
Required string length:
1 - 200Response
Endereço gravado
O escopo do domínio: o club. Tudo que o produto cria pertence a um.
Show child attributes
Show child attributes