Pedir uma exportação

Pede uma exportação

curl --request POST \
  --url https://api.weve.cx/v1/clubs/{clubId}/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "from": "2023-12-25",
    "to": "2023-12-25",
    "status": "<string>",
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

import requests

url = "https://api.weve.cx/v1/clubs/{clubId}/exports"

payload = { "filters": {
        "from": "2023-12-25",
        "to": "2023-12-25",
        "status": "<string>",
        "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    } }
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({
    filters: {
      from: '2023-12-25',
      to: '2023-12-25',
      status: '<string>',
      product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      delivery_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      course_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    }
  })
};

fetch('https://api.weve.cx/v1/clubs/{clubId}/exports', 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}/exports",
  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([
    'filters' => [
        'from' => '2023-12-25',
        'to' => '2023-12-25',
        'status' => '<string>',
        'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'delivery_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'course_id' => '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}/exports"

	payload := strings.NewReader("{\n  \"filters\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\",\n    \"status\": \"<string>\",\n    \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"course_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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}/exports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\",\n    \"status\": \"<string>\",\n    \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"course_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.weve.cx/v1/clubs/{clubId}/exports")

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  \"filters\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\",\n    \"status\": \"<string>\",\n    \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"course_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "kind": "full",
    "format": "csv",
    "filters": {
      "from": "2023-12-25",
      "to": "2023-12-25",
      "status": "<string>",
      "access": "active",
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "status": "pending",
    "rows_total": 123,
    "rows_done": 123,
    "size_bytes": 123,
    "file_name": "<string>",
    "error": "<string>",
    "requested_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "download_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z",
    "expires_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>"
  }
}

POST

clubs

{clubId}

exports

Pede uma exportação

curl --request POST \
  --url https://api.weve.cx/v1/clubs/{clubId}/exports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": {
    "from": "2023-12-25",
    "to": "2023-12-25",
    "status": "<string>",
    "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'

import requests

url = "https://api.weve.cx/v1/clubs/{clubId}/exports"

payload = { "filters": {
        "from": "2023-12-25",
        "to": "2023-12-25",
        "status": "<string>",
        "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    } }
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({
    filters: {
      from: '2023-12-25',
      to: '2023-12-25',
      status: '<string>',
      product_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      delivery_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      course_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    }
  })
};

fetch('https://api.weve.cx/v1/clubs/{clubId}/exports', 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}/exports",
  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([
    'filters' => [
        'from' => '2023-12-25',
        'to' => '2023-12-25',
        'status' => '<string>',
        'product_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'delivery_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'course_id' => '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}/exports"

	payload := strings.NewReader("{\n  \"filters\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\",\n    \"status\": \"<string>\",\n    \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"course_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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}/exports")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\",\n    \"status\": \"<string>\",\n    \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"course_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.weve.cx/v1/clubs/{clubId}/exports")

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  \"filters\": {\n    \"from\": \"2023-12-25\",\n    \"to\": \"2023-12-25\",\n    \"status\": \"<string>\",\n    \"product_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"delivery_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"course_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "kind": "full",
    "format": "csv",
    "filters": {
      "from": "2023-12-25",
      "to": "2023-12-25",
      "status": "<string>",
      "access": "active",
      "product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "delivery_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "course_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "status": "pending",
    "rows_total": 123,
    "rows_done": 123,
    "size_bytes": 123,
    "file_name": "<string>",
    "error": "<string>",
    "requested_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "download_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z",
    "expires_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>"
  }
}

A resposta chega na hora, com a exportação em pending. O arquivo é gerado em segundo plano: consulte a exportação até status ser ready e então peça o download.

curl -X POST https://api.weve.cx/v1/clubs/$CLUB_ID/exports \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"kind": "purchases", "format": "xlsx", "filters": {"status": "paid", "from": "2026-01-01", "to": "2026-01-31"}}'

Authorizations

Authorization

string

header

required

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

clubId

string<uuid>

required

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

kind

enum<string>

required

O que exportar. full é a exportação completa, um .zip com todos os outros tipos.

Available options:

full,

students,

enrollments,

purchases,

subscriptions,

course_progress

format

enum<string>

csv quando ausente.

Available options:

csv,

xlsx

filters

object

Os filtros do pedido. Cada tipo aceita os seus (ver GET .../export-kinds); mandar outro é invalid_filter. As datas são dias no fuso de São Paulo, com as duas pontas incluídas.

Show child attributes

Response

Na fila — ou o pedido idêntico que já estava lá

data

object

required

Show child attributes

Health

Conta de quem administra

Acesso do aluno

Clubs

Plataformas de venda

Webhooks de saída

Exportações

Eventos de webhook

Catálogo

Conteúdo

Classroom do aluno

Comentários

Comunidade

Mentorias

Agentes

Lives

Alunos

Links de cadastro

Campanhas

Automações

Preferências de e-mail

Pedir uma exportação

Authorizations

Path Parameters

Body

Response