API DoCRM: журнал запросов и диагностика интеграций

Для кого эта инструкция

Для технического администратора с правом «Отчёт по запросам API DoCRM», который диагностирует работу внешней интеграции по журналу запросов.

Где находится

В левом меню нажмите «Отчёты» → «API DoCRM». Кнопка отображается только при праве на этот отчёт; создание и ограничение токенов выполняются в другом разделе настроек.

Выберите период журнала

Вверху укажите даты «От» и «До». Стрелки по сторонам полей сдвигают весь интервал назад или вперёд на его длину. Нажмите круглую кнопку обновления, чтобы построить журнал за выбранный период.

Прочитайте строку API-запроса

В таблице каждая строка — один запрос к API. Проверьте:

• «Когда» — дата и время запроса;
• «Статус» — HTTP-код; успешный 200 выделен зелёным;
• «Метод» — HTTP-метод и путь;
• «Токен» — название экземпляра API-токена, которым сделан запрос;
• «Тело» и «Ответ» — данные запроса и ответ сервера.

Используйте пагинацию внизу таблицы для перехода по журналу. В настройке размера страницы доступны 25, 50, 100, 250, 500 и 1000 строк.

Важно: тела запросов и ответы могут содержать данные интеграции или клиентов. Давайте доступ к этому отчёту только тем, кому он нужен для диагностики, и не копируйте содержимое журнала в открытые чаты или документы.

Действуйте по результату

Если видите ожидаемые 200, проверьте путь и имя токена — это подтверждает, что журнал записывает нужную интеграцию. Для других кодов сначала сопоставьте метод и тело запроса с разрешёнными эндпоинтами токена, затем проверьте внешнюю систему. Сам токен не изменяйте из журнала: для этого используйте инструкцию «API-токены DoCRM: создание, доступ и отзыв».

Интерактивная спецификация находится по адресу https://***.docrm.org/scalar, где *** — поддомен вашей школы. В ней можно сверить HTTP-метод, путь, обязательные поля и схему ответа.

Готово: технический администратор построил журнал API, нашёл запрос по периоду, методу и токену и понимает, какие данные использовать для диагностики.