АПИ для ФССП: мониторинг организаций

6 часов назад
СУДиДЕЛО.рф
1 минута

АПИ СУДиДЕЛО позволяет получать исполнительные производства ФССП по организации, включённой в мониторинг компаний. В веб-приложении этим данным соответствует раздел /MonitoringResultListFsspCompany.

Подключение и API KEY

Скопируйте API KEY пользователя в разделе «Интеграция — API». Порядок получения ключа описан в статье «Открытое API системы СУДиДЕЛО». Базовый адрес: https://api-sudodelo.torkndgov.ru. Методы и схемы ответов: Swagger, MonitoringCompanies.

Во всех методах этой статьи apiKey передаётся в строке запроса. Ключ определяет пользователя и его организацию; доступны только записи мониторинга этой организации. Храните ключ на сервере интеграции и исключайте его из публичных ссылок и журналов.

1. Найти или добавить организацию

Сначала найдите компанию по ИНН. В адресах следующих методов {id} означает идентификатор компании мониторинга, а не ИНН, ОГРН или идентификатор найденного дела.

GET /api/MonitoringCompanies/id-by-inn-or-name?apiKey=YOUR_API_KEY&inn=ИНН_ОРГАНИЗАЦИИ

Возьмите items[].id нужной компании. Можно искать по name — части названия; нужен хотя бы один из параметров inn и name. Если заданы оба, достаточно совпадения по любому из них. При hasMore=true уточните запрос: возвращается до 100 совпадений.

Для обхода всех компаний используйте GET /api/MonitoringCompanies?apiKey=YOUR_API_KEY&numberPage=1&pageSize=100. В этом ответе идентификатор компании называется items[].dicElementId.

Если компании ещё нет, добавьте её в мониторинг:

POST /api/MonitoringCompanies?apiKey=YOUR_API_KEY
Content-Type: application/json

{
  "companyName": "НАЗВАНИЕ_ОРГАНИЗАЦИИ",
  "inn": "ИНН_ОРГАНИЗАЦИИ"
}

Замените значения реальными реквизитами. Поля companyName и inn обязательны. Сохраните dicElementId из созданной карточки. Повторное добавление того же ИНН возвращает 400: используйте существующую запись. После добавления запускается фоновый сбор сведений; результаты могут появиться не сразу.

2. Получить результаты мониторинга

GET /api/MonitoringCompanies/{id}/fssp?apiKey=YOUR_API_KEY&numberPage=1&pageSize=100

Обязательны id и apiKey. Необязательные параметры: numberPage — номер страницы с 1 (по умолчанию 1), pageSize — размер страницы (по умолчанию 100, максимум 1000).

Пример curl: замените 12345 на идентификатор компании, а YOUR_API_KEY — на свой ключ.

curl --fail --get "https://api-sudodelo.torkndgov.ru/api/MonitoringCompanies/12345/fssp" \
  --data-urlencode "apiKey=YOUR_API_KEY" \
  --data-urlencode "numberPage=1" \
  --data-urlencode "pageSize=100"

3. Разобрать ответ и получить следующие страницы

  • section — название раздела
  • numberPage, pageSize — фактический номер и размер страницы
  • returnedCount — количество элементов на текущей странице
  • totalCount — общее количество записей в выборке
  • items — массив результатов

Увеличивайте numberPage, пока numberPage × pageSize не достигнет totalCount. Пустой items также означает, что эту выборку можно завершить. Пустой результат при существующей компании — успешный ответ; он не доказывает отсутствие событий в первоисточнике. При обновлении данных между запросами состав страниц может измениться.

Поля элемента items

  • dicElementId — идентификатор записи исполнительного производства в мониторинге
  • debtor — должник
  • addressDebtor — адрес должника
  • dateInstitution — дата возбуждения производства, строка
  • numberOfEnforcement — номер исполнительного производства
  • executiveDocument — тип исполнительного документа
  • dateExecutiveDocument — дата исполнительного документа, строка
  • numberOfExecutiveDocument — номер исполнительного документа
  • objectOfExecutiveDocuments — требования исполнительного документа
  • objectExecution — предмет исполнения
  • amountPaid — сумма в строковом формате источника
  • departments — отдел судебных приставов
  • addressDepartments — адрес отдела

Записи упорядочены по убыванию даты dateInstitution. Необязательные поля могут содержать null.

Особенности и связь с интерфейсом

Возвращаются записи, у которых распознанная дата возбуждения не раньше текущей серверной даты минус три года. Записи с пустой или нераспознаваемой датой не включаются. Параметров изменения этого периода нет; для более узкого периода фильтруйте полученные записи на стороне интеграции. Поле amountPaid — строка: не считайте его автоматически числовым остатком долга. Этот метод читает результаты мониторинга, а не запускает новый поиск через отдельный сервис /api/FsspSearch.

Веб-раздел показывает результаты по списку компаний, а метод API получает их по одной компании. Для общей выгрузки сначала пройдите список мониторинга, затем вызовите метод для каждого идентификатора. В текущем методе нет параметров dateFrom, dateTo или фильтров колонок: нужный отбор выполняйте после получения всех страниц. Запрос читает накопленные результаты и не запускает немедленное обновление первоисточника.

Коды ответов и обработка ошибок

  • 200 — успешный запрос; проверьте содержимое ответа, включая пустые значения.
  • 400 — некорректные параметры; при создании компании — также дубликат ИНН.
  • 401 — ключ не передан или недействителен.
  • 404 — компания не найдена в мониторинге вашей организации.

При ошибке прочитайте тело ответа с пояснением причины. Не записывайте API KEY в журнал диагностики.

Смотрите также: Открытое API системы СУДиДЕЛО, АПИ для ЕГРЮЛ и полное описание методов мониторинга компаний.