Reordena os módulos e as aulas do curso
curl --request PUT \
--url https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"modules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lessons": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
]
}
'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure"
payload = { "modules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lessons": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
modules: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
lessons: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
}
]
})
};
fetch('https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure', 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.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'modules' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'lessons' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]),
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.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure"
payload := strings.NewReader("{\n \"modules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lessons\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"modules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lessons\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"modules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lessons\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"slug": "<string>",
"public_id": "<string>",
"visibility": "members",
"show_modules": true,
"release": {
"kind": "all",
"children": "<array>",
"days": 1825,
"at": "2023-11-07T05:31:56Z",
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"module_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"count": 2
},
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"modules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"position": 123,
"show_when_empty": true,
"archived": true,
"release": {
"kind": "all",
"children": "<array>",
"days": 1825,
"at": "2023-11-07T05:31:56Z",
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"module_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"count": 2
},
"lessons": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"module_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"public_id": "<string>",
"type": "video",
"position": 123,
"archived": true,
"release": {
"kind": "all",
"children": "<array>",
"days": 1825,
"at": "2023-11-07T05:31:56Z",
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"module_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"count": 2
},
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"body": "<unknown>",
"media": {
"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"
},
"attachments": [
{
"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"
}
],
"duration_seconds": 123,
"published_at": "2023-11-07T05:31:56Z"
}
]
}
],
"description": "<string>",
"cover": {
"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"
},
"published_at": "2023-11-07T05:31:56Z"
}
}{
"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>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Conteúdo
Reordenar o curso
A árvore inteira numa chamada: ordem dos módulos, ordem das aulas, e a aula que muda de módulo.
PUT
/
v1
/
clubs
/
{clubId}
/
courses
/
{courseId}
/
structure
Reordena os módulos e as aulas do curso
curl --request PUT \
--url https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"modules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lessons": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
]
}
'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure"
payload = { "modules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lessons": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
modules: [
{
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
lessons: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
}
]
})
};
fetch('https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure', 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.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'modules' => [
[
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'lessons' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]),
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.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure"
payload := strings.NewReader("{\n \"modules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lessons\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"modules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lessons\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/structure")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"modules\": [\n {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"lessons\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"slug": "<string>",
"public_id": "<string>",
"visibility": "members",
"show_modules": true,
"release": {
"kind": "all",
"children": "<array>",
"days": 1825,
"at": "2023-11-07T05:31:56Z",
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"module_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"count": 2
},
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"modules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"position": 123,
"show_when_empty": true,
"archived": true,
"release": {
"kind": "all",
"children": "<array>",
"days": 1825,
"at": "2023-11-07T05:31:56Z",
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"module_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"count": 2
},
"lessons": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"module_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"public_id": "<string>",
"type": "video",
"position": 123,
"archived": true,
"release": {
"kind": "all",
"children": "<array>",
"days": 1825,
"at": "2023-11-07T05:31:56Z",
"lesson_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"module_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"count": 2
},
"created_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"body": "<unknown>",
"media": {
"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"
},
"attachments": [
{
"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"
}
],
"duration_seconds": 123,
"published_at": "2023-11-07T05:31:56Z"
}
]
}
],
"description": "<string>",
"cover": {
"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"
},
"published_at": "2023-11-07T05:31:56Z"
}
}{
"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>"
}
}{
"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
Os módulos na ordem final, cada um com as suas aulas.
Show child attributes
Show child attributes
Response
O curso, na ordem nova
Show child attributes
Show child attributes