SIEDUC API v2

Sistema de Gestão Escolar Multi-institucional

Autenticação

Utilizamos o Laravel Passport com o fluxo de Password Grant. Todos os tokens devem ser enviados no header de autorização.

Authorization: Bearer {access_token}
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json

Padrão JSON:API

Seguimos rigorosamente a especificação JSON:API. Isso significa que as respostas são estruturadas com data, attributes e relationships.

Filtros

?filter[name]=Matematica

Inclusões

?include=institution,schoolYear

Endpoints de Referência

Método Recurso / Endpoint Descrição
GET|POST /api/v2/users Gestão de usuários e perfis.
GET|POST /api/v2/institutions Listagem de escolas vinculadas.
GET|POST /api/v2/services Ofertas educacionais (Aggregate Root).
GET|POST /api/v2/subjects Catálogo global de disciplinas.
POST /api/v2/login Autenticação de usuários.

Hierarquia de Serviços

Service
Service Course
Service Phase
Service Subject

Nota: O Service é o Aggregate Root que vincula Institution a um SchoolYear.