Запуск

Выполните после установки, в административном разделе сайта.

1. Задайте адреса

1. Откройте «Сервисы → API-платформа → Настройки модуля».
2. На вкладке «Основные», в блоке «Настройка путей», заполните поля:

3. Нажмите «Сохранить».

Пути указываются без домена. Модуль сам создаст точки входа и включит API.

2. Включите проверочные запросы

1. Перейдите на вкладку «Роуты».
2. Отметьте «Активировать сервисные роуты».
3. Нажмите «Сохранить».

3. Откройте документацию API

1. Выберите «Сервисы → API-платформа → Документация».
2. Проверьте адрес страницы: при указанных выше настройках это /api/docs/ на вашем сайте.
3. В поле Servers проверьте адрес API: он должен указывать на ваш сайт и путь /api/.

В списке операций должен быть GET /up. Это встроенный запрос проверки API.

4. Выполните первый запрос

1. Раскройте GET /up.
2. Нажмите Try it out, затем Execute. Кнопка Authorize для этого запроса не нужна.
3. В блоке Server response найдите фактический код и тело ответа.

Результат: код 200, в Response body — JSON с result.method = GET и result.action = list. Пример полного ответа:

{
  "request_id": "0af1b6c2d3e4f5a6b7c8d9e0f1a2b3c4",
  "status": {
    "code": 200,
    "title": "200 OK",
    "message": "success"
  },
  "result": {
    "method": "GET",
    "controller": "Native\\Api\\Controller\\Up\\UpIndex",
    "action": "list",
    "description": "Проверка доступности и работоспособности API-сервиса",
    "parameters": []
  },
  "time": {
    "start": 1790586000.125,
    "finish": 1790586000.1875,
    "duration": 0.0625,
    "date_start": "28.09.2026 12:00:00",
    "date_finish": "28.09.2026 12:00:00",
    "timestamp": {
      "date_start": 1790586000,
      "date_finish": 1790586000
    }
  }
}

5. Продолжите проверку

Оставьте сервисные роуты включёнными и перейдите к проверке работы. Там проверяются параметры, авторизация, токены и история запросов.

Если результат отличается

Если ошибка остаётся, сохраните адрес запроса, HTTP-код и ответ без паролей и токенов. Передайте их в поддержку.