Configura o certificado do curso
curl --request PUT \
--url https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/certificate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"title": "<string>",
"body": "<string>",
"hours": 5000,
"signature_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signature_name": "<string>",
"signature_role": "<string>"
}
'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/certificate"
payload = {
"enabled": True,
"title": "<string>",
"body": "<string>",
"hours": 5000,
"signature_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signature_name": "<string>",
"signature_role": "<string>"
}
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({
enabled: true,
title: '<string>',
body: JSON.stringify('<string>'),
hours: 5000,
signature_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
signature_name: '<string>',
signature_role: '<string>'
})
};
fetch('https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/certificate', 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}/certificate",
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([
'enabled' => true,
'title' => '<string>',
'body' => '<string>',
'hours' => 5000,
'signature_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'signature_name' => '<string>',
'signature_role' => '<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.weve.cx/v1/clubs/{clubId}/courses/{courseId}/certificate"
payload := strings.NewReader("{\n \"enabled\": true,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"hours\": 5000,\n \"signature_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"signature_name\": \"<string>\",\n \"signature_role\": \"<string>\"\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}/certificate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"hours\": 5000,\n \"signature_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"signature_name\": \"<string>\",\n \"signature_role\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/certificate")
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 \"enabled\": true,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"hours\": 5000,\n \"signature_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"signature_name\": \"<string>\",\n \"signature_role\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"enabled": true,
"title": "<string>",
"suggested_hours": 1,
"issued_count": 1,
"body": "<string>",
"hours": 5000,
"signature_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signature_url": "<string>",
"signature_name": "<string>",
"signature_role": "<string>",
"updated_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>"
}
}Certificados
Configurar o certificado do curso
Liga o certificado do curso e define título, texto, carga horária e assinatura.
PUT
/
v1
/
clubs
/
{clubId}
/
courses
/
{courseId}
/
certificate
Configura o certificado do curso
curl --request PUT \
--url https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/certificate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"enabled": true,
"title": "<string>",
"body": "<string>",
"hours": 5000,
"signature_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signature_name": "<string>",
"signature_role": "<string>"
}
'import requests
url = "https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/certificate"
payload = {
"enabled": True,
"title": "<string>",
"body": "<string>",
"hours": 5000,
"signature_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signature_name": "<string>",
"signature_role": "<string>"
}
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({
enabled: true,
title: '<string>',
body: JSON.stringify('<string>'),
hours: 5000,
signature_media_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
signature_name: '<string>',
signature_role: '<string>'
})
};
fetch('https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/certificate', 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}/certificate",
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([
'enabled' => true,
'title' => '<string>',
'body' => '<string>',
'hours' => 5000,
'signature_media_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'signature_name' => '<string>',
'signature_role' => '<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.weve.cx/v1/clubs/{clubId}/courses/{courseId}/certificate"
payload := strings.NewReader("{\n \"enabled\": true,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"hours\": 5000,\n \"signature_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"signature_name\": \"<string>\",\n \"signature_role\": \"<string>\"\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}/certificate")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"hours\": 5000,\n \"signature_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"signature_name\": \"<string>\",\n \"signature_role\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.weve.cx/v1/clubs/{clubId}/courses/{courseId}/certificate")
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 \"enabled\": true,\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"hours\": 5000,\n \"signature_media_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"signature_name\": \"<string>\",\n \"signature_role\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"enabled": true,
"title": "<string>",
"suggested_hours": 1,
"issued_count": 1,
"body": "<string>",
"hours": 5000,
"signature_media_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signature_url": "<string>",
"signature_name": "<string>",
"signature_role": "<string>",
"updated_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>"
}
}Ligar vale para quem já concluiu. Todo aluno que já tinha fechado o curso recebe o
certificado nos minutos seguintes, em lotes — não é só dali para frente.
Desligar não revoga o que já foi emitido: certificado emitido é fato, e desfazê-lo é
revogar, com motivo.
O
body aceita os marcadores {aluno}, {curso}, {club}, {carga_horaria}, {data},
{codigo} e {aulas}. Marcador desconhecido é recusado com invalid_placeholder (422) — ele
não sai vazio no certificado de ninguém.
curl -X PUT https://api.weve.cx/v1/clubs/$CLUB_ID/courses/$COURSE_ID/certificate \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"title": "Certificado de conclusão",
"hours": 40,
"body": "concluiu o curso {curso}, com carga horária de {carga_horaria}, em {data}.",
"signature_name": "Ana Ribeiro",
"signature_role": "Diretora de ensino"
}'
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 - 120Maximum string length:
600Required range:
1 <= x <= 10000Maximum string length:
120Maximum string length:
120Response
A configuração gravada
O que o curso imprime no certificado. Curso que nunca configurou nada
responde com os padrões e enabled: false.
Show child attributes
Show child attributes