АПИ для проверки блокировки счёта ФНС

6 часов назад

СУДиДЕЛО.рф

1 минута

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

Подключение и 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}/fns-account-lock?apiKey=YOUR_API_KEY

Укажите идентификатор компании мониторинга и API KEY. ИНН берётся из карточки компании. Параметров пагинации, периода или статуса блокировки у метода нет.

Пример curl: замените 12345 и YOUR_API_KEY своими значениями.

curl --fail --get "https://api-sudodelo.torkndgov.ru/api/MonitoringCompanies/12345/fns-account-lock" \
  --data-urlencode "apiKey=YOUR_API_KEY"

3. Разобрать ответ

content — HTML или текст, полученный сервисом по ИНН; может быть null
sourceUrl — адрес источника данных

Ответ — JSON-объект с двумя полями. Поле content не является массивом решений и не содержит отдельного логического поля isBlocked. В ответе удаляется текст «Скачать PDF»; отдельного публичного метода скачивания PDF для этого раздела в Swagger нет.

Как обрабатывать отсутствие сведений

HTTP 200 и content: null не означают «блокировок нет». Такой ответ возможен, если в карточке не указан ИНН либо внешний источник недоступен или не вернул содержимое. Показывайте состояние «нет данных» и повторяйте проверку позднее, не подменяя его заключением об отсутствии блокировки.

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

Связь с веб-приложением

В разделе /MonitoringResultListFnsLock/ доступны фильтры «Все», «Есть блокировка», «Нет блокировок». Публичный API возвращает сведения по одной компании; аналогичный общий список можно построить обходом GET /api/MonitoringCompanies и запросом fns-account-lock для каждого dicElementId. Фильтр статуса интерфейса не передаётся в этот метод.

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

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

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