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

O modelo responsável

O modelo responsável contém os dados de identificação e acesso mobile. Use o cpf junto com o CNPJ da escola para identificar unicamente um responsável.

cpf string

CPF do responsável (11 dígitos).

name string

Nome completo do responsável.

birthdate date

Data de nascimento do responsável.

email string

Endereço de e-mail de acesso ao app.

mobile_access_status string

Status de acesso ao aplicativo mobile.

school_cnpj string

CNPJ da escola à qual o responsável está vinculado.

client_cnpj string

CNPJ do cliente ao qual o responsável pertence.

Modelo responsável

{
  "cpf": "12345678900",
  "name": "Maria da Silva",
  "birthdate": "1985-06-20",
  "email": "maria@email.com",
  "mobile_access_status": "ACTIVE",
  "school_cnpj": "26019466000122",
  "client_cnpj": "12345678000199"
}

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

Listar responsáveis

Retorna todos os responsáveis 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}/responsibles/all

curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/responsibles/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/{cnpj}/responsibles/all', [
    'headers' => [
        'X-Authorization' => '{api_token}',
        'X-Partner'       => '{partner_token}',
        'X-Client'        => '{client_slug}',
    ],
]);
$responsibles = json_decode($response->getBody(), true);

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

Resposta

{
  "data": [
    {
      "cpf": "12345678900",
      "name": "Maria da Silva",
      "school_cnpj": "26019466000122",
      // ...
    }
  ],
  "links": { /* URLs de paginação */ },
  "meta": { "current_page": 1, "per_page": 25, // ... }
}

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

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

GET /v1/partners/school/{cnpj}/responsible/{cpf}

Obter um responsável

Retorna os dados completos de um responsável identificado pelo CPF dentro de uma escola.

Parâmetros de rota

cnpj string obrigatório

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

cpf string obrigatório

CPF do responsável (11 dígitos, sem formatação).

Códigos de resposta

200

Sucesso.

401

Autenticação inválida.

404

Recurso não encontrado.

Requisição GET

GET /v1/partners/school/{cnpj}/responsible/{cpf}

curl https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900 \
  -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/responsible/12345678900',
    ['headers' => ['X-Authorization' => '{api_token}', 'X-Partner' => '{partner_token}', 'X-Client' => '{client_slug}']]
);
$responsible = json_decode($response->getBody(), true);

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

Resposta

{
  "data": {
    "cpf": "12345678900",
    "name": "Maria da Silva",
    "birthdate": "1985-06-20",
    "email": "maria@email.com",
    "school_cnpj": "26019466000122"
  }
}

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

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

POST /v1/partners/school/{cnpj}/responsible

Criar responsável

Cria um novo responsável e o vincula à escola informada. Um usuário de acesso será criado automaticamente com o e-mail fornecido.

Parâmetros de rota

cnpj string obrigatório

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

Corpo da requisição

name string obrigatório

Nome completo do responsável.

birthdate date obrigatório

Data de nascimento (ex: 1985-06-20).

cpf string (11) obrigatório

CPF do responsável sem formatação.

email string obrigatório

E-mail único para acesso ao aplicativo.

phone string opcional

Número de celular (até 11 dígitos).

Códigos de resposta

200

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}/responsible

curl -X POST https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}" \
  -H "Content-Type: application/json" \
  -d '{"name":"Maria da Silva","birthdate":"1985-06-20","cpf":"12345678900","email":"maria@email.com"}'

use GuzzleHttp\Client;

$client = new Client();
$response = $client->post('https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible', [
    'headers' => [
        'X-Authorization' => '{api_token}',
        'X-Partner'       => '{partner_token}',
        'X-Client'        => '{client_slug}',
    ],
    'json' => [
        'name'      => 'Maria da Silva',
        'birthdate' => '1985-06-20',
        'cpf'       => '12345678900',
        'email'     => 'maria@email.com',
    ],
]);

const response = await fetch('https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible', {
    method: 'POST',
    headers: {
        'X-Authorization': '{api_token}',
        'X-Partner':       '{partner_token}',
        'X-Client':        '{client_slug}',
        'Content-Type':    'application/json',
    },
    body: JSON.stringify({ name: 'Maria da Silva', birthdate: '1985-06-20', cpf: '12345678900', email: 'maria@email.com' }),
});

Resposta

{
  "data": {
    "cpf": "12345678900",
    "name": "Maria da Silva",
    "birthdate": "1985-06-20",
    "email": "maria@email.com",
    "school_cnpj": "26019466000122"
  }
}

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

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

PUT /v1/partners/school/{cnpj}/responsible/{cpf}

Editar responsável

Atualiza os dados de um responsável existente. Apenas os campos enviados serão alterados.

Parâmetros de rota

cnpj string obrigatório

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

cpf string obrigatório

CPF atual do responsável (11 dígitos, sem formatação).

Corpo da requisição

name string opcional

Novo nome completo do responsável.

birthdate date opcional

Nova data de nascimento.

cpf string (11) opcional

Novo CPF (11 dígitos, sem formatação).

email string opcional

Novo e-mail de acesso.

phone string opcional

Novo número de celular.

Códigos de resposta

200

Sucesso.

400

Dados inválidos.

401

Autenticação inválida.

404

Recurso não encontrado.

Requisição PUT

PUT /v1/partners/school/{cnpj}/responsible/{cpf}

curl -X PUT https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900 \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}" \
  -H "Content-Type: application/json" \
  -d '{"name":"Maria Silva Atualizada"}'

use GuzzleHttp\Client;

$client = new Client();
$response = $client->put(
    'https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900',
    ['headers' => [...], 'json' => ['name' => 'Maria Silva Atualizada']]
);

const response = await fetch(
    'https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900',
    { method: 'PUT', headers: { ... }, body: JSON.stringify({ name: 'Maria Silva Atualizada' }) }
);

Resposta

{
  "data": {
    "cpf": "12345678900",
    "name": "Maria Silva Atualizada",
    // ...
  }
}

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

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

DELETE /v1/partners/school/{cnpj}/responsible/{cpf}

Excluir responsável

Remove um responsável da plataforma. O registro é excluído de forma lógica (soft delete).

Parâmetros de rota

cnpj string obrigatório

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

cpf string obrigatório

CPF do responsável (11 dígitos, sem formatação).

Códigos de resposta

200

Sucesso.

401

Autenticação inválida.

404

Recurso não encontrado.

Requisição DELETE

DELETE /v1/partners/school/{cnpj}/responsible/{cpf}

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

use GuzzleHttp\Client;

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

await fetch(
    'https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900',
    { 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."
}

GET /v1/partners/school/{cnpj}/responsible/{cpf}/students

Listar alunos do responsável

Retorna a lista paginada de alunos cujo responsável principal é o identificado pelo CPF informado.

Parâmetros de rota

cnpj string obrigatório

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

cpf string obrigatório

CPF do responsável (11 dígitos, sem formatação).

Códigos de resposta

200

Sucesso.

401

Autenticação inválida.

404

Recurso não encontrado.

Requisição GET

GET /v1/partners/school/{cnpj}/responsible/{cpf}/students

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

$response = $client->get(
    'https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900/students',
    ['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/responsible/12345678900/students',
    { headers: { 'X-Authorization': '{api_token}', 'X-Partner': '{partner_token}', 'X-Client': '{client_slug}' } }
);
const data = await response.json();

Resposta

{
  "data": [
    {
      "enrollment_number": "7.553",
      "name": "João da Silva",
      // ...
    }
  ]
}

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

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

POST /v1/partners/school/{cnpj}/responsible/{cpf}/student/{enrollment_number}

Vincular aluno

Define o responsável como responsável principal do aluno identificado pelo número de matrícula.

Parâmetros de rota

cnpj string obrigatório

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

cpf string obrigatório

CPF do responsável (11 dígitos, sem formatação).

enrollment_number string obrigatório

Número de matrícula do aluno.

Códigos de resposta

200

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}/responsible/{cpf}/student/{enrollment_number}

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

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

await fetch(
    'https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900/student/7.553',
    { method: 'POST', 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."
}

DELETE /v1/partners/school/{cnpj}/responsible/{cpf}/student/{enrollment_number}

Desvincular aluno

Remove o vínculo de responsável principal entre o responsável e o aluno. O campo responsible_id do aluno é definido como null.

Parâmetros de rota

cnpj string obrigatório

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

cpf string obrigatório

CPF do responsável (11 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}/responsible/{cpf}/student/{enrollment_number}

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

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

await fetch(
    'https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900/student/7.553',
    { 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."
}

GET /v1/partners/school/{cnpj}/responsible/{cpf}/additional-students

Alunos adicionais do responsável

Retorna a lista paginada de alunos nos quais o responsável foi definido como responsável adicional.

Parâmetros de rota

cnpj string obrigatório

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

cpf string obrigatório

CPF do responsável (11 dígitos, sem formatação).

Códigos de resposta

200

Sucesso.

401

Autenticação inválida.

404

Recurso não encontrado.

Requisição GET

GET /v1/partners/school/{cnpj}/responsible/{cpf}/additional-students

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

$response = $client->get(
    'https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900/additional-students',
    ['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/responsible/12345678900/additional-students',
    { headers: { 'X-Authorization': '{api_token}', 'X-Partner': '{partner_token}', 'X-Client': '{client_slug}' } }
);
const data = await response.json();

Resposta

{
  "data": [
    {
      "enrollment_number": "8.001",
      "name": "Ana Paula",
      // ...
    }
  ]
}

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

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

POST /v1/partners/school/{cnpj}/responsible/{cpf}/additional-student/{enrollment_number}

Vincular aluno adicional

Adiciona o responsável como responsável adicional do aluno identificado pelo número de matrícula.

Parâmetros de rota

cnpj string obrigatório

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

cpf string obrigatório

CPF do responsável (11 dígitos, sem formatação).

enrollment_number string obrigatório

Número de matrícula do aluno.

Códigos de resposta

200

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}/responsible/{cpf}/additional-student/{enrollment_number}

curl -X POST https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900/additional-student/8.001 \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"

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

await fetch(
    'https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900/additional-student/8.001',
    { method: 'POST', 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."
}

DELETE /v1/partners/school/{cnpj}/responsible/{cpf}/additional-student/{enrollment_number}

Desvincular aluno adicional

Remove o responsável da lista de responsáveis adicionais do aluno identificado pelo número de matrícula.

Parâmetros de rota

cnpj string obrigatório

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

cpf string obrigatório

CPF do responsável (11 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}/responsible/{cpf}/additional-student/{enrollment_number}

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

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

await fetch(
    'https://toakiescola.com.br/api/v1/partners/school/26019466000122/responsible/12345678900/additional-student/8.001',
    { 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."
}

Responsáveis

O modelo responsável

Listar responsáveis

Parâmetros de rota

Códigos de resposta

Obter um responsável

Parâmetros de rota

Códigos de resposta

Criar responsável

Parâmetros de rota

Corpo da requisição

Códigos de resposta

Editar responsável

Parâmetros de rota

Corpo da requisição

Códigos de resposta

Excluir responsável

Parâmetros de rota

Códigos de resposta

Listar alunos do responsável

Parâmetros de rota

Códigos de resposta

Vincular aluno

Parâmetros de rota

Códigos de resposta

Desvincular aluno

Parâmetros de rota

Códigos de resposta

Alunos adicionais do responsável

Parâmetros de rota

Códigos de resposta

Vincular aluno adicional

Parâmetros de rota

Códigos de resposta

Desvincular aluno adicional

Parâmetros de rota

Códigos de resposta