Autenticação

Para acessar qualquer endpoint da API do To Aqui Escola você deve incluir três cabeçalhos HTTP em todas as suas requisições. Esses cabeçalhos identificam o parceiro, o token de autorização e o cliente (rede escolar) sendo acessado.

Cabeçalhos obrigatórios

X-Authorization

Token de autorização

Token único fornecido ao parceiro durante o processo de onboarding. Identifica e autoriza sua integração.

X-Partner

Token do parceiro

Identificador exclusivo do parceiro no ecossistema To Aqui. Usado em conjunto com o X-Authorization.

X-Client

Slug do cliente

Identificador em texto da rede escolar (cliente) que está sendo acessada. Exemplo: colegio-exemplo.

Exemplo de requisição autenticada

Adicione os três cabeçalhos em todas as chamadas à API. Substitua os valores pelos tokens fornecidos pela equipe To Aqui.

curl https://toakiescola.com.br/api/v1/partners/schools/all \
  -H "X-Authorization: dSpAucKX4JIyfkqX9sZHKFblHr92tvJD..." \
  -H "X-Partner: A6XKzcXg1rsNfI0XSENocEOBWoOnDHMa..." \
  -H "X-Client: colegio-exemplo"

use GuzzleHttp\Client;

$client = new Client();

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

$data = json_decode($response->getBody(), true);

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

const data = await response.json();

Autenticação inválida

Quando um ou mais cabeçalhos estiverem ausentes ou inválidos, a API retornará um erro 401 Unauthorized.

Resposta de erro 401

{
  "message": "Unauthorized."
}