Документация API

Smrt English Client API

API только для чтения, который передает данные учащихся и групп в системы вашего учебного заведения. Каждый API-ключ (API key) дает доступ только к данным своего учебного заведения.

Открыть центр тестирования

Как это работает

Как выполняется запрос

Ваша система запрашивает данные учащегося или группы со своим API-ключом, а API возвращает эти данные только для чтения.

Ваша системаВаша система учета учащихся или инструмент отчетности.

Ваш API-ключПередается с каждым запросом и привязан к вашей школе.

Smrt English APIКонечные точки (эндпоинты) только для чтения по учащимся и группам.

Ваши данныеОценки, посещаемость и списки групп в формате 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