Primeiros passos
Este guia mostra como realizar sua primeira requisição à API do To Aqui Escola. Você aprenderá como obter suas credenciais, configurar os cabeçalhos de autenticação e fazer a sua primeira chamada.
Obtenha suas credenciais
Entre em contato com a equipe do To Aqui para receber suas credenciais de parceiro. Você receberá três valores necessários para autenticação:
X-Authorization
Token de autorização único do seu parceiro.
X-Partner
Identificador do parceiro no sistema.
X-Client
Slug do cliente (rede escolar) que você está acessando.
Faça sua primeira requisição
Com as credenciais em mãos, faça uma requisição para listar todas as escolas do seu cliente. Este é o endpoint mais simples para validar que sua autenticação está funcionando.
-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/schools/all', [ 'headers' => [ 'X-Authorization' => '{api_token}', 'X-Partner' => '{partner_token}', 'X-Client' => '{client_slug}', ], ]); $schools = 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 schools = await response.json();
Entenda a resposta
Uma resposta bem-sucedida retorna uma resposta paginada com as escolas do cliente autenticado no campo data, acompanhada de metadados de paginação.
{ "data": [ { "id": "9faea287-2f03-4b26-b234-3d3c1a2bc4e1", "social_name": "Colégio Exemplo LTDA", "name": "Colégio Exemplo", "cnpj": "26019466000122" } ], "links": { /* URLs de paginação */ }, "meta": { "current_page": 1, "per_page": 25, /* ... */ } }