Pular para o conteúdo

Documentação da API

Client API da Smrt English

Uma API somente leitura que envia registros de alunos e turmas para os sistemas da sua instituição. Cada API key acessa apenas os dados da própria instituição.

Abra o ambiente de testes

Como funciona

Como funciona uma requisição.

O seu sistema solicita um aluno ou uma turma com a própria API key, e a API devolve os registros em modo somente leitura.

O seu sistemaO seu sistema de gestão acadêmica ou a sua ferramenta de relatórios.
A sua API keyEnviada em cada requisição e vinculada à sua escola.
API da Smrt EnglishEndpoints somente leitura para alunos e turmas.
Os seus registrosNotas, frequência e listas das turmas em JSON.
keyboard_arrow_up

Smrt English API

vpn_key Authentication

All API requests require authentication using an API key passed in the HTTP header.

Header Format

X-API-Key: your_institution_api_key

Authentication Methods

The API supports the following header variations:

  • X-API-Key (recommended)
  • X-Api-Key
  • HTTP_X_API_KEY (server variable)

Security Notes

  • Keep your API key confidential and do not share it outside your institution
  • Never expose API keys in client-side code or public repositories
  • Use HTTPS for all API requests (enforced in production)
  • Your API key only provides access to your institution's student data