To Aqui - O app que descomplica a comunicação escolar

O modelo matrícula

O modelo matrícula contém os dados de vínculo do aluno com a turma, seu número de matrícula e o status atual. Use o id para referenciar a matrícula nas operações de edição.

id uuid

Identificador único da matrícula.

number string

Número de matrícula do aluno.

status string

Status da matrícula. Valores possíveis: MATRICULADO, TRANSFERIDO, DESISTENTE, APROVADO, REPROVADO, FALECIDO, REMANEJADA, CANCELADA.

student_name string

Nome completo do aluno.

school_cnpj string

CNPJ da escola à qual a matrícula pertence.

classroom_name string

Nome da turma à qual o aluno está matriculado.

Modelo matrícula

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "number": "7.553",
  "status": "MATRICULADO",
  "student_name": "João da Silva",
  "school_cnpj": "26019466000122",
  "classroom_name": "Turma A"
}

GET /v1/partners/school/{cnpj}/enrollments/all

Listar matrículas

Retorna todas as matrículas de uma escola específica, identificada pelo CNPJ. A resposta é paginada, com os registros em data.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

Códigos de resposta

200

Sucesso.

401

Autenticação inválida.

Requisição GET

GET /v1/partners/school/{cnpj}/enrollments/all

curl https://toakiescola.com.br/api/v1/partners/school/26019466000122/enrollments/all \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

use GuzzleHttp\Client;

$client = new Client();
$response = $client->get('https://toakiescola.com.br/api/v1/partners/school/26019466000122/enrollments/all', [
    'headers' => [
        'X-Authorization' => '{api_token}',
        'X-Partner'       => '{partner_token}',
        'X-Client'        => '{client_slug}',
    ],
]);
$enrollments = json_decode($response->getBody(), true);

const response = await fetch('https://toakiescola.com.br/api/v1/partners/school/26019466000122/enrollments/all', {
    headers: {
        'X-Authorization': '{api_token}',
        'X-Partner':       '{partner_token}',
        'X-Client':        '{client_slug}',
    },
});
const enrollments = await response.json();

Resposta

{
  "data": [
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "number": "7.553",
      "status": "MATRICULADO",
      "student_name": "João da Silva",
      // ...
    }
  ],
  "links": { /* URLs de paginação */ },
  "meta": { "current_page": 1, "per_page": 25, // ... }
}

{
  "message": "Autenticação inválida."
}

{
  "message": "Recurso não encontrado."
}

POST /v1/partners/school/{cnpj}/student/{enrollment_number}/enroll

Matricular aluno

Matricula um aluno em uma turma da escola. O aluno é identificado pelo seu número de matrícula atual e a turma pelo classroom_id no corpo da requisição.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

enrollment_number string obrigatório

Número de matrícula atual do aluno.

Corpo da requisição

classroom_id uuid obrigatório

UUID da turma em que o aluno será matriculado.

Códigos de resposta

201

Criado com sucesso.

400

Dados inválidos.

401

Autenticação inválida.

404

Recurso de referência não encontrado.

Requisição POST

POST /v1/partners/school/{cnpj}/student/{enrollment_number}/enroll

curl https://toakiescola.com.br/api/v1/partners/school/26019466000122/student/7.553/enroll \
  -X POST \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}" \
  -H "Content-Type: application/json" \
  -d '{"classroom_id":"a1b2c3d4-..."}'

use GuzzleHttp\Client;

$client = new Client();
$response = $client->post('https://toakiescola.com.br/api/v1/partners/school/26019466000122/student/7.553/enroll', [
    'headers' => [
        'X-Authorization' => '{api_token}',
        'X-Partner'       => '{partner_token}',
        'X-Client'        => '{client_slug}',
    ],
    'json' => [
        'classroom_id' => '{classroom_id}',
    ],
]);
$enrollment = json_decode($response->getBody(), true);

const response = await fetch('https://toakiescola.com.br/api/v1/partners/school/26019466000122/student/7.553/enroll', {
    method: 'POST',
    headers: {
        'X-Authorization': '{api_token}',
        'X-Partner':       '{partner_token}',
        'X-Client':        '{client_slug}',
        'Content-Type':    'application/json',
    },
    body: JSON.stringify({ classroom_id: '{classroom_id}' }),
});
const enrollment = await response.json();

Resposta

{
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "number": "7.553",
    "status": "MATRICULADO",
    "student_name": "João da Silva",
    "school_cnpj": "26019466000122",
    "classroom_name": "Turma A"
  }
}

{
  "message": "Autenticação inválida."
}

{
  "message": "Recurso não encontrado."
}

PATCH /v1/partners/school/{cnpj}/enrollment/{enrollment_id}/number

Editar número de matrícula

Atualiza o número de matrícula de uma matrícula existente. Útil quando o sistema de gestão do parceiro precisa sincronizar ou corrigir o número de matrícula de um aluno.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

enrollment_id string obrigatório

UUID da matrícula.

Corpo da requisição

number string obrigatório

Novo número de matrícula do aluno (máx. 50 caracteres).

Códigos de resposta

200

Sucesso.

400

Dados inválidos.

401

Autenticação inválida.

404

Recurso não encontrado.

Requisição PATCH

PATCH /v1/partners/school/{cnpj}/enrollment/{enrollment_id}/number

curl https://toakiescola.com.br/api/v1/partners/school/26019466000122/enrollment/b2c3d4e5-.../number \
  -X PATCH \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}" \
  -H "Content-Type: application/json" \
  -d '{"number":"8.001"}'

use GuzzleHttp\Client;

$client = new Client();
$response = $client->patch('https://toakiescola.com.br/api/v1/partners/school/26019466000122/enrollment/{id}/number', [
    'headers' => [
        'X-Authorization' => '{api_token}',
        'X-Partner'       => '{partner_token}',
        'X-Client'        => '{client_slug}',
    ],
    'json' => ['number' => '8.001'],
]);

const response = await fetch('https://toakiescola.com.br/api/v1/partners/school/26019466000122/enrollment/{id}/number', {
    method: 'PATCH',
    headers: {
        'X-Authorization': '{api_token}',
        'X-Partner':       '{partner_token}',
        'X-Client':        '{client_slug}',
        'Content-Type':    'application/json',
    },
    body: JSON.stringify({ number: '8.001' }),
});

Resposta

{
  "data": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "number": "8.001",
    "status": "MATRICULADO",
    // ...
  }
}

{
  "message": "Autenticação inválida."
}

{
  "message": "Recurso não encontrado."
}

DELETE /v1/partners/school/{cnpj}/student/{enrollment_number}/unenroll

Desmatricular aluno

Remove a matrícula ativa de um aluno, identificado pelo seu número de matrícula. A operação é irreversível.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

enrollment_number string obrigatório

Número de matrícula do aluno.

Códigos de resposta

200

Sucesso.

401

Autenticação inválida.

404

Recurso não encontrado.

Requisição DELETE

DELETE /v1/partners/school/{cnpj}/student/{enrollment_number}/unenroll

curl https://toakiescola.com.br/api/v1/partners/school/26019466000122/student/7.553/unenroll \
  -X DELETE \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

use GuzzleHttp\Client;

$client = new Client();
$response = $client->delete('https://toakiescola.com.br/api/v1/partners/school/26019466000122/student/7.553/unenroll', [
    'headers' => [
        'X-Authorization' => '{api_token}',
        'X-Partner'       => '{partner_token}',
        'X-Client'        => '{client_slug}',
    ],
]);

const response = await fetch('https://toakiescola.com.br/api/v1/partners/school/26019466000122/student/7.553/unenroll', {
    method: 'DELETE',
    headers: {
        'X-Authorization': '{api_token}',
        'X-Partner':       '{partner_token}',
        'X-Client':        '{client_slug}',
    },
});

Resposta

{
  "success": true
}

{
  "message": "Autenticação inválida."
}

{
  "message": "Recurso não encontrado."
}

Matrículas

O modelo matrícula

Listar matrículas

Parâmetros de rota

Códigos de resposta

Matricular aluno

Parâmetros de rota

Corpo da requisição

Códigos de resposta

Editar número de matrícula

Parâmetros de rota

Corpo da requisição

Códigos de resposta

Desmatricular aluno

Parâmetros de rota

Códigos de resposta