Документация1С-Битрикс: Модулиnative.api

Проверка работы

Начните после успешного GET /up из раздела «Запуск». Все шаги выполняйте на тестовом сайте, в том же браузере и под той же учётной записью администратора. Для проверки токенов используйте HTTPS.

Ниже API расположен по адресу /api/. Если вы задали другой путь, замените его в примерах.

1. Проверьте параметры запроса

  1. Откройте новую вкладку браузера.
  2. На своём сайте перейдите по адресу /api/up/user/15?name=Ivan.
  3. Найдите в JSON поле result.parameters.

Результат: в parameters есть id со значением 15 и name со значением Ivan. Это проверочный запрос: он не создаёт и не изменяет пользователя.

2. Проверьте отсутствующий адрес

Откройте /api/check-not-found на своём сайте.

Результат: JSON-ошибка ROUTE_NOT_FOUND, в status.code — 404.

3. Проверьте авторизацию

  1. В настройках модуля откройте вкладку «Роуты».
  2. Отметьте «Активировать нативные роуты» и нажмите «Сохранить».
  3. Обновите страницу документации /api/docs/. В ней появятся операции /token.
  4. Нажмите Authorize. Если в basicAuth или bearerAuth уже сохранены данные, нажмите для них Logout, затем Close. Из админки сайта выходить не нужно.
  5. Откройте GET /token и нажмите Try it out → Execute.

Без авторизации: в Server response код 401.

  1. Нажмите Authorize. В блоке basicAuth укажите логин и пароль учётной записи, под которой открыта админка. Нажмите Authorize, затем Close.
  2. Повторите GET /token кнопкой Execute.

С авторизацией: код 200. Если токены ещё не выпускались, поле result может отсутствовать.

Если получен AUTH_MFA_REQUIRED, завершите вход с одноразовым кодом на сайте под этим же пользователем и повторите запрос в том же браузере. Проверку MFA отключать не нужно.

4. Выпустите токены

  1. Откройте POST /token и нажмите Try it out → Execute. Параметры заполнять не нужно.
  2. Проверьте код 201 в Server response.
  3. В Response body, в массиве result, найдите два объекта: с type = access и type = refresh.
  4. Сохраните значение token из каждого объекта. Не меняйте браузер до конца проверки.
  5. Выполните GET /token и сохраните client.id из записи с датой только что выполненного выпуска. Он понадобится для отзыва.

Повторный POST /token в этом браузере заменит выданную пару. Для следующих шагов используйте последние значения.

5. Обновите токены

  1. Нажмите Authorize. В basicAuth нажмите Logout.
  2. В блок bearerAuth вставьте refresh-токен без слова Bearer. Нажмите Authorize, затем Close.
  3. Выполните PUT /token через Try it out → Execute.
  4. Проверьте код 200 и сохраните оба новых токена из result.
  5. Не меняя значение в bearerAuth, повторите PUT /token.

Результат повторного запроса: код 401. Старый refresh-токен больше не действует.

6. Отзовите токены

  1. Нажмите Authorize. В bearerAuth нажмите Logout и укажите новый access-токен из шага 5.
  2. Нажмите Authorize, затем Close.
  3. Откройте DELETE /token, нажмите Try it out и вставьте сохранённый client.id в поле client_id.
  4. Нажмите Execute.

Результат: код 200, в ответе result.delete = true. Если получено false, проверьте client_id: нужная сессия не была отозвана.

  1. Повторите тот же запрос с тем же токеном.

После отзыва: код 401.

7. Проверьте историю и данные запроса

  1. В настройках модуля, на вкладке «Аналитика», отметьте «Собирать входящие запросы» и сохраните настройки.
  2. На вкладке «Логирование», в блоке «Входящие запросы», отметьте «Записывать входящие данные» и «Записывать исходящие данные». Соседние флажки «записывать в файл» для этой проверки не нужны.
  3. Сохраните настройки.
  4. В новой вкладке откройте /api/up?check=history на своём сайте. Скопируйте request_id из ответа.
  5. Перейдите в «Сервисы → API-платформа → Входящие запросы». Обновите список и найдите запрос по этому идентификатору.
  6. Откройте его карточку нажатием на ID. Проверьте вкладки «Входящие данные» и «Исходящие данные».

Результат: для этого request_id есть одна запись. Во входящих данных виден параметр check = history, в исходящих — ответ API. Если данных нет, проверьте, что запрос выполнен после сохранения обеих настроек логирования и включения сбора.

8. Завершите проверку

  1. В документации нажмите Authorize и Logout для оставшихся сохранённых данных.
  2. На вкладке «Роуты» отключите сервисные роуты. Нативные роуты оставьте включёнными только если будете использовать операции с токенами.
  3. Сохраните настройки. Верните параметры аналитики и логирования к нужным для сайта значениям.
  4. Удалите сохранённые для проверки значения токенов.

Если ожидаемые результаты получены, базовая проверка пройдена. Для проверки прав, ограничений, собственных роутов и удаления модуля используйте подробные сценарии.

Если шаг не пройден, сохраните его номер, HTTP-код и ответ без паролей и токенов. Разбор ошибок запуска.