Відкритий API

Щоб скористатися API до нашого реєстру реєстрів, просто додайте параметр format=json до адреси сторінки з результатами пошуку, наприклад, так:

https://ring.org.ua/search?q=кононенко&datasources=smida&datasources=posipaky_info&datasources=posipaky_2_info&datasources=edrdr&datasources=garnahata_in_ua&datasources=vkks&datasources=nacp_declarations&datasources=paper_declarations&datasources=cvk_2015&datasources=smida_reports&datasources=dabi_licenses&datasources=dabi_registry&format=json


Таким чином, ви отримаєте ті самі результати, але в форматі машиночитних даних. Документ з результатами складається з наступних розділів:

  • search_results — знайдені документи та інформація щодо поточної сторінки
  • query — ваш запит до системи
  • search_type — режим пошуку (strict — повний збіг, loose — неповний збіг)
  • strict_count — кількість результатів в режимі повного збіг
  • loose_count — кількість результатів в режимі неповного збіг
  • base_count — кількість результатів в поточному режимі пошуку
  • enabled_datasources — джерела по котрим проводиться пошук
  • datasources — додаткова інформація по джерелам пошуку, включно з назвою українською

Вміст search_results складається з наступних полів:

  • paginator — інформація про поточну сторінку та розбивку на сторінки, де count — загальна кількість результатів, num_pages — кількість сторінок, per_page — кількість результатів на сторінку
  • number — номер поточної сторінки
  • object_list — власне, результати пошуку

Звісно, що документи з різних джерел пошуку (наприклад, декларацій та реєстру компаній) будуть мати різну структуру, але деякі з полів будуть єдині для всіх джерел:

  • id — унікальний ідентифікатор документа
  • source — датасет-джерело (використовуйте поле datasources щоб отримати більше інформації про датасет)
  • last_updated_from_dataset — остання дата, коли ми знайшли цей запис в оригінальному датасеті (може бути відсутня)
  • first_updated_from_dataset — перша дата, коли ми знайшли цей запис в оригінальному датасеті (може бути відсутня)
Окрім того ми витягаємо, чистимо та доповнюємо (наприклад, перекладаємо російською) наступні сутності:
  • persons — перелік осіб, що були зазначені в документі (може бути відсутній)
  • companies — перелік компаній, що були зазначені в документі (може бути відсутній)
  • addresses — перелік адрес, що були зазначені в документі (може бути відсутній)
  • countries — перелік країн, що були зазначені в документі (може бути відсутній)

Ви також можете використовувати параметр entities в параметрах запиту щоб обмежити пошук тільки по компаніях (companies), персонах (persons), країнах (countries) або адресах (addresses).