Rest API
Status
Em construção
Visão geral
A API REST HÉLICO expõe recursos para consumo pelo frontend e integrações externas. Os contratos cobrem Produtos, Trilhas, Unidades, Módulos, Atividades, Simulados e Desempenho.
Abaixo estão exemplos iniciais de payloads consolidados a partir dos protótipos existentes. Estes exemplos serão refinados conforme os contratos forem versionados.
Recursos (alto nível)
- Produtos
- Listagem de Produtos disponíveis (sincronizados via e-commerce)
- Trilhas
- Detalhe da Trilha do Produto (fluxos, unidades, flags)
- Unidades
- Detalhe da Unidade habilitada na Trilha (conteúdos e metadados)
- Módulos
- Dados do Módulo atual do aluno (quantidade de unidades, status das etapas)
- Avaliações (DI/SVD)
- Geração e submissão de simulados VF; resultados e classificação (B/I/A)
- Atividades
- Resumo, Leitura, Leitura de Reforço; registro no Caderno Online
- Revisões
- Revisão do Módulo (flashcards) e Revisão Geral (inclui Simulado Objetivo)
- Simulados Escritos
- Upload por QR code ou desktop; status e correção (apoio de IA)
- Desempenho
- Métricas e relatórios (definições em evolução)
Convenções
- Versionamento de endpoints (v1, v2…) conforme evolução.
- Códigos de status HTTP consistentes (2xx sucesso, 4xx erros de cliente, 5xx servidor).
- Schemas JSON com tipagem explícita; timestamps em ISO 8601.
Exemplos
Produtos — GET /api/products
{
"success": true,
"data": [
{
"id": 87,
"product_shortname": "MPSP - Reta Final",
"product_name": "MPSP - Reta Final",
"category_name": "MPSP"
},
{
"id": 88,
"product_shortname": "MPSP - Simulados VF",
"product_name": "MPSP - Simulados VF",
"category_name": "MPSP"
},
{
"id": 89,
"product_shortname": "MPSP - Simulados Escritos",
"product_name": "MPSP - Simulados Escritos",
"category_name": "MPSP"
},
{
"id": 90,
"product_shortname": "MPSP - Simulados Objetivas",
"product_name": "MPSP - Simulados Objetivas",
"category_name": "MPSP"
},
{
"id": 94,
"product_shortname": "oab_discipline",
"product_name": "OAB teste",
"category_name": "OAB"
}
]
}Trilha — GET /api/trilha/{productId}
{
"success": true,
"data": {
"id": 184,
"course_shortname": "MPSP - Curso Regular",
"fullname": "Olá",
"enableContent": false,
"enableModuleStep": false,
"initialDiagnosis": false,
"moduleReview": false,
"stepReview": false,
"loopingFlow": true,
"unidades": [
{
"id": 149,
"name": "UNIDADE 1",
"courseid": "159",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_1"
},
{
"id": 150,
"name": "UNIDADE 2",
"courseid": "160",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_2"
},
{
"id": 151,
"name": "UNIDADE 3",
"courseid": "161",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_3"
},
{
"id": 152,
"name": "UNIDADE 4",
"courseid": "162",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_4"
},
{
"id": 153,
"name": "UNIDADE 5",
"courseid": "163",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_5"
},
{
"id": 154,
"name": "UNIDADE 6",
"courseid": "164",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_6"
},
{
"id": 155,
"name": "UNIDADE 7",
"courseid": "165",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_7"
},
{
"id": 156,
"name": "UNIDADE 8",
"courseid": "166",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_8"
},
{
"id": 157,
"name": "UNIDADE 9",
"courseid": "167",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_9"
},
{
"id": 158,
"name": "UNIDADE 10",
"courseid": "168",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_10"
},
{
"id": 43,
"name": "HORA Nº 01",
"courseid": "46",
"category_name": "Teste de upload",
"course_shortname": "horan01_1748961542"
},
{
"id": 159,
"name": "UNIDADE 11",
"courseid": "169",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_11"
},
{
"id": 160,
"name": "UNIDADE 12",
"courseid": "170",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_12"
},
{
"id": 161,
"name": "UNIDADE 13",
"courseid": "171",
"category_name": "Processo Civil I",
"course_shortname": "PROCESSO_CIVIL_I_13"
}
]
}
}Unidade — GET /api/unidade/{id}
{
"success": true,
"data": {
"id": 149,
"name": "UNIDADE 1",
"courseid": 159,
"category_name": "Processo Civil I",
"category_idnumber": "PROCESSO_CIVIL_I",
"course_shortname": "PROCESSO_CIVIL_I_1",
"incidence": 8,
"relevance": 4,
"content": "..."
}
}