Cria uma turma
curl --request POST \
--url https://api.weve.cx/v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"admission": "window",
"enrolls_from": "2023-11-07T05:31:56Z",
"enrolls_until": "2023-11-07T05:31:56Z",
"offers": [
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_offer_id": "<string>"
}
],
"access": "until_end",
"access_days": 2,
"bonus_deliveries": [
{
"delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"access_days": 2
}
]
}
'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts"
payload = {
"name": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"admission": "window",
"enrolls_from": "2023-11-07T05:31:56Z",
"enrolls_until": "2023-11-07T05:31:56Z",
"offers": [
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_offer_id": "<string>"
}
],
"access": "until_end",
"access_days": 2,
"bonus_deliveries": [
{
"delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"access_days": 2
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
starts_at: '2023-11-07T05:31:56Z',
ends_at: '2023-11-07T05:31:56Z',
admission: 'window',
enrolls_from: '2023-11-07T05:31:56Z',
enrolls_until: '2023-11-07T05:31:56Z',
offers: [
{
connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
external_offer_id: '<string>'
}
],
access: 'until_end',
access_days: 2,
bonus_deliveries: [{delivery_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', access_days: 2}]
})
};
fetch('https://api.weve.cx/v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts', 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}/deliveries/{deliveryId}/cohorts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'starts_at' => '2023-11-07T05:31:56Z',
'ends_at' => '2023-11-07T05:31:56Z',
'admission' => 'window',
'enrolls_from' => '2023-11-07T05:31:56Z',
'enrolls_until' => '2023-11-07T05:31:56Z',
'offers' => [
[
'connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'external_offer_id' => '<string>'
]
],
'access' => 'until_end',
'access_days' => 2,
'bonus_deliveries' => [
[
'delivery_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'access_days' => 2
]
]
]),
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}/deliveries/{deliveryId}/cohorts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"admission\": \"window\",\n \"enrolls_from\": \"2023-11-07T05:31:56Z\",\n \"enrolls_until\": \"2023-11-07T05:31:56Z\",\n \"offers\": [\n {\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_offer_id\": \"<string>\"\n }\n ],\n \"access\": \"until_end\",\n \"access_days\": 2,\n \"bonus_deliveries\": [\n {\n \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"access_days\": 2\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.weve.cx/v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"admission\": \"window\",\n \"enrolls_from\": \"2023-11-07T05:31:56Z\",\n \"enrolls_until\": \"2023-11-07T05:31:56Z\",\n \"offers\": [\n {\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_offer_id\": \"<string>\"\n }\n ],\n \"access\": \"until_end\",\n \"access_days\": 2,\n \"bonus_deliveries\": [\n {\n \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"access_days\": 2\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"admission\": \"window\",\n \"enrolls_from\": \"2023-11-07T05:31:56Z\",\n \"enrolls_until\": \"2023-11-07T05:31:56Z\",\n \"offers\": [\n {\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_offer_id\": \"<string>\"\n }\n ],\n \"access\": \"until_end\",\n \"access_days\": 2,\n \"bonus_deliveries\": [\n {\n \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"access_days\": 2\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"admission": "window",
"offers": [
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_offer_id": "<string>"
}
],
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"access": "lifetime",
"bonus_deliveries": [
{
"delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delivery_name": "<string>",
"access_days": 2
}
],
"enrolled_count": 123,
"member_count": 123,
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"enrolls_from": "2023-11-07T05:31:56Z",
"enrolls_until": "2023-11-07T05:31:56Z",
"access_days": 123
}
}{
"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>"
}
}Catálogo
Criar turma
Uma turma agrupa as matrículas de uma entrega, com janela própria. A compra paga dentro da janela de matrícula entra nela.
POST
/
v1
/
clubs
/
{clubId}
/
deliveries
/
{deliveryId}
/
cohorts
Cria uma turma
curl --request POST \
--url https://api.weve.cx/v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"admission": "window",
"enrolls_from": "2023-11-07T05:31:56Z",
"enrolls_until": "2023-11-07T05:31:56Z",
"offers": [
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_offer_id": "<string>"
}
],
"access": "until_end",
"access_days": 2,
"bonus_deliveries": [
{
"delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"access_days": 2
}
]
}
'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts"
payload = {
"name": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"admission": "window",
"enrolls_from": "2023-11-07T05:31:56Z",
"enrolls_until": "2023-11-07T05:31:56Z",
"offers": [
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_offer_id": "<string>"
}
],
"access": "until_end",
"access_days": 2,
"bonus_deliveries": [
{
"delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"access_days": 2
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
starts_at: '2023-11-07T05:31:56Z',
ends_at: '2023-11-07T05:31:56Z',
admission: 'window',
enrolls_from: '2023-11-07T05:31:56Z',
enrolls_until: '2023-11-07T05:31:56Z',
offers: [
{
connection_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
external_offer_id: '<string>'
}
],
access: 'until_end',
access_days: 2,
bonus_deliveries: [{delivery_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', access_days: 2}]
})
};
fetch('https://api.weve.cx/v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts', 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}/deliveries/{deliveryId}/cohorts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'starts_at' => '2023-11-07T05:31:56Z',
'ends_at' => '2023-11-07T05:31:56Z',
'admission' => 'window',
'enrolls_from' => '2023-11-07T05:31:56Z',
'enrolls_until' => '2023-11-07T05:31:56Z',
'offers' => [
[
'connection_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'external_offer_id' => '<string>'
]
],
'access' => 'until_end',
'access_days' => 2,
'bonus_deliveries' => [
[
'delivery_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'access_days' => 2
]
]
]),
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}/deliveries/{deliveryId}/cohorts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"admission\": \"window\",\n \"enrolls_from\": \"2023-11-07T05:31:56Z\",\n \"enrolls_until\": \"2023-11-07T05:31:56Z\",\n \"offers\": [\n {\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_offer_id\": \"<string>\"\n }\n ],\n \"access\": \"until_end\",\n \"access_days\": 2,\n \"bonus_deliveries\": [\n {\n \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"access_days\": 2\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.weve.cx/v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"admission\": \"window\",\n \"enrolls_from\": \"2023-11-07T05:31:56Z\",\n \"enrolls_until\": \"2023-11-07T05:31:56Z\",\n \"offers\": [\n {\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_offer_id\": \"<string>\"\n }\n ],\n \"access\": \"until_end\",\n \"access_days\": 2,\n \"bonus_deliveries\": [\n {\n \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"access_days\": 2\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/deliveries/{deliveryId}/cohorts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"ends_at\": \"2023-11-07T05:31:56Z\",\n \"admission\": \"window\",\n \"enrolls_from\": \"2023-11-07T05:31:56Z\",\n \"enrolls_until\": \"2023-11-07T05:31:56Z\",\n \"offers\": [\n {\n \"connection_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"external_offer_id\": \"<string>\"\n }\n ],\n \"access\": \"until_end\",\n \"access_days\": 2,\n \"bonus_deliveries\": [\n {\n \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"access_days\": 2\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"admission": "window",
"offers": [
{
"connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"external_offer_id": "<string>"
}
],
"starts_at": "2023-11-07T05:31:56Z",
"ends_at": "2023-11-07T05:31:56Z",
"access": "lifetime",
"bonus_deliveries": [
{
"delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"delivery_name": "<string>",
"access_days": 2
}
],
"enrolled_count": 123,
"member_count": 123,
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"enrolls_from": "2023-11-07T05:31:56Z",
"enrolls_until": "2023-11-07T05:31:56Z",
"access_days": 123
}
}{
"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
Required string length:
1 - 200Como se entra na turma. window: pela data de pagamento, dentro da
janela de matrícula. offer: pelos códigos de oferta reivindicados,
sem janela — é o que permite turmas simultâneas.
Available options:
window, offer Obrigatório na admissão por janela; proibido na por oferta.
Obrigatório (ao menos uma) na admissão por oferta.
Show child attributes
Show child attributes
Como a janela de acesso de quem entra é calculada. until_end vai
até ends_at; days_from_start conta access_days de starts_at;
days_from_enrollment conta de quando a pessoa entrou.
Available options:
lifetime, until_end, days_from_start, days_from_enrollment Obrigatório nos modos que contam dias; ignorado nos outros.
Required range:
x >= 1Show child attributes
Show child attributes
Response
Turma criada
Show child attributes
Show child attributes