API — Отслеживание изменений
Позволяет создавать список компаний и ИП и использовать его для отслеживания изменений ваших контрагентов в ЕГРЮЛ и ЕГРИП.
Формат запроса
Используются POST- или GET-запросы следующего вида
https://api.ofdata.ru/v2/track?key=API-ключ&параметры запроса
Параметр запроса | Описание |
---|---|
mode |
Обязательный параметр
Определяет тип поиска, принимает следующие значения:
mode=add для добавления компаний и ИП в список отслеживания,mode=remove для удаления компаний и ИП из списка отслеживания,mode=view для просмотра списка отслеживания,mode=check для проверки наличия изменений контрагентов из списка отслеживания в ЕГРЮЛ и ЕГРИП,mode=changes для просмотра последних изменений. |
ogrn |
Для
mode=add , mode=remove , mode=changes Должен быть указан, если не указан ИНН
ОГРН компании или ОРГНИП индивидуального предпринимателя. |
inn |
Для
mode=add , mode=remove , mode=changes Должен быть указан, если не указан ОГРН или ОГРНИП
Если вы не указали ОГРН или ОГРНИП, вы должны указать ИНН компании или предпринимателя. |
kpp |
Для
Если вы указали ИНН компании, вы можете указать и ее КПП. Связка ИНН + КПП является уникальной и позволяет точно определить компанию.
mode=add , mode=remove , mode=changes |
date |
Для
Дата для проверки изменений, указывается в формате mode=check YYYY-MM-DD . Также можно указать date=yesterday для проверки последних изменений, за вчерашний день.
|
Примеры запросов
https://api.ofdata.ru/v2/track?key=API-ключ&mode=add&ogrn=1027700198767
https://api.ofdata.ru/v2/track?key=API-ключ&mode=remove&inn=7707049388
https://api.ofdata.ru/v2/track?key=API-ключ&mode=view
https://api.ofdata.ru/v2/track?key=API-ключ&mode=check&date=yesterday
https://api.ofdata.ru/v2/track?key=API-ключ&mode=changes&ogrn=1027700198767
Примечания
- API-ключ вы можете найти в личном кабинете после регистрации.
- Вы можете использовать как защищенное https://SSL-соединение, так и незащищенноеhttp://соединение. Например, если при интеграции с 1С вы получаете "Ошибка инициализации SSL-соединения", воспользуйтесь незащищенным соединением через 80-й порт.
- Обычно ФНС публикует обновления ЕГРЮЛ и ЕГРИП за прошедший день после полуночи, поэтому, для ежедневной проверки изменений рекомендуем указывать date=yesterdayи выполнять запрос после 09:00 по московскому времени.
Формат ответа
Для просмотра списка отслеживания
{
}
data: {
Отслеж: {
Список контрагентов для отслеживания
Всего: <INTEGER>,
Количество записей вашего списка контрагентов
Записи: [ <STRING>, ... ]
ОГРН или ОГРНИП контрагентов
}
},
meta: {
Информация о результате запроса
status: <STRING>,
Статус ответа, принимает значения "ok" или "error"
today_request_count: <INTEGER>,
Количество успешно обработанных запросов с вашим API-ключом за сегодняшний день
message: <STRING>
Сообщение, поясняющее результат запроса, отсутствует в случае успешной обработки запроса и получении ответа, содержащего требуемые данные
}
Для проверки наличия изменений контрагентов из списка отслеживания в ЕГРЮЛ и ЕГРИП
{
}
data: {
ДатаОбнов: <STRING>,
Дата обновления
Отслеж: {
Контрагенты из вашего списка отслеживания, для которых есть обновления на указанную дату
Всего: <INTEGER>,
Количество записей
Записи: [ <STRING>, ... ]
ОГРН или ОГРНИП контрагентов
}
},
meta: {
Информация о результате запроса
status: <STRING>,
Статус ответа, принимает значения "ok" или "error"
today_request_count: <INTEGER>,
Количество успешно обработанных запросов с вашим API-ключом за сегодняшний день
message: <STRING>
Сообщение, поясняющее результат запроса, отсутствует в случае успешной обработки запроса и получении ответа, содержащего требуемые данные
}
Для просмотра последних изменений
{
data: {
}
company: {
Компания, определенная по ОГРН или ИНН
ОГРН: <STRING>,
ОГРН
ИНН: <STRING>,
ИНН
КПП: <STRING>,
КПП
НаимСокр: <STRING>,
Сокращенное наименование
НаимПолн: <STRING>,
Полное наименование
ДатаРег: <STRING>,
Дата регистрации
Статус: <STRING>,
Статус
ДатаЛикв: <STRING>,
Дата ликвидации
РегионКод: <STRING>,
Код региона РФ
ЮрАдрес: <STRING>,
Юридический адрес
ОКВЭД: <STRING>
Основной вид деятельности согласно ОКВЭД
},
entrepreneur: {
ИП, определенный по ОГРНИП или ИНН
ОГРНИП: <STRING>,
ОГРНИП
ИНН: <STRING>,
ИНН
ФИО: <STRING>,
Ф. И. О.
Тип: <STRING>,
Наименование типа ИП
ДатаРег: <STRING>,
Дата регистрации
Статус: <STRING>,
Статус
ДатаПрекращ: <STRING>,
Дата прекращения деятельности
РегионКод: <STRING>,
Код региона РФ
ОКВЭД: <STRING>
Основной вид деятельности согласно ОКВЭД
},
Актуал: { ... },
Актуальная информация ЕГРЮЛ или ЕГРИП
Пред: { ... },
Предыдущая информация ЕГРЮЛ или ЕГРИП
Измен: { ... }
Изменения
},
meta: {
Информация о результате запроса
status: <STRING>,
Статус ответа, принимает значения "ok" или "error"
today_request_count: <INTEGER>,
Количество успешно обработанных запросов с вашим API-ключом за сегодняшний день
message: <STRING>
Сообщение, поясняющее результат запроса, отсутствует в случае успешной обработки запроса и получении ответа, содержащего требуемые данные
}