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

verified_user Authentication Test Endpoint

Endpoint Details

Endpoint: GET /smrtapi/v1/auth

Purpose: Verify that your API key is valid and active

Headers Required

X-API-Key: your_institution_api_key

Example Request

curl -H "X-API-Key: your_institution_api_key" \
  https://smrtenglish.com/smrtapi/v1/auth

Use Cases

Verify API key before implementing full integration
Test connectivity to the API
Confirm school information and permissions
Health check for API availability

Response Format

Success Response (200 OK):

{
  "success": true,
  "data": {
    "authenticated": true,
    "school": {
      "id": 1,
      "name": "Your Institution Name",
      "key": "your_institution"
    },
    "api_key_name": "Your Institution Production API Key",
    "timestamp": "2025-09-29 22:20:32"
  },
  "message": "API key is valid and active"
}

Error Response (401 Unauthorized):

{
  "error": true,
  "message": "Authentication required",
  "status_code": 401,
  "error_code": "AUTH_REQUIRED"
}

Response Fields

Field	Type	Description
`authenticated`	boolean	Always true for successful auth
`school.id`	integer	Your institution's unique ID
`school.name`	string	Your institution's name
`school.key`	string	Your institution's unique key
`api_key_name`	string	Friendly name for the API key
`timestamp`	string	Server timestamp