Administração escolar
Conectar os seus sistemas com a API da Smrt English
Leia os registros de alunos e turmas da sua escola nos seus próprios sistemas com uma API key da Smrt English.
A API da Smrt English permite que os sistemas da sua escola, como um sistema de gestão acadêmica ou um painel de relatórios, leiam os registros de alunos e turmas. Ela é somente leitura: não pode adicionar, alterar nem excluir nada na Smrt English.
Obter uma API key
Entre em contato com a Smrt English para solicitar uma API key para a sua escola. A Smrt English emite e gerencia as chaves. Uma chave só retorna os alunos e as turmas da sua própria escola.
Quando a sua escola tiver uma chave, abra o Dashboard, clique em Home e depois em Settings. O quadro Client API mostra quantas chaves estão ativas e quantas requisições elas fizeram nos últimos 30 dias.
Entregue a chave à pessoa que vai desenvolver a integração. Ela envia a chave no cabeçalho X-API-Key de cada requisição.
O que você pode ler
- Alunos: uma lista dos seus alunos com filtros e busca, ou um aluno pelo ID de usuário ou e-mail, incluindo as turmas, as atividades concluídas, as avaliações e o tempo dedicado aos estudos.
- Turmas: uma lista das suas turmas, ou uma turma com o professor e a lista de alunos.
- Auth: um teste que verifica se a sua chave funciona.
A referência completa, com exemplos em PHP, Python e JavaScript, está na documentação da API. O seu desenvolvedor pode testar cada endpoint no navegador pela central de testes indicada ali.
Trate a chave como uma senha. Guarde-a no seu servidor, nunca em uma página web ou aplicativo. Se achar que ela foi exposta, entre em contato com a Smrt English imediatamente.
