Це основний запит, з якого зазвичай починають роботу з даними конкретного підприємства в ESG SaveEcoBot API.
У відповіді ви отримаєте базову інформацію про підприємство, посилання на таймлайн і перелік доступних секцій даних. Частина секцій є простими, наприклад, адреси, контакти або види діяльності, а частина є доменними й веде до окремих даних про дозволи, реєстри, звіти, повідомлення, ОВД, СЕО та інші тематичні розділи.
GET /api/v1/enterprises/{registry_id}
У відповіді повертаються основні дані підприємства, таймлайн і секції з посиланнями на пов’язані розділи.
Параметр registry_id в адресі запиту є обов'язковим — це ідентифікатор підприємства.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Поля відповіді
results.enterprise
type: тип підприємства. Можливі значення:companyабоfop.registry_id: ідентифікатор підприємства.name: повна назва підприємства. Станом наedr_updated_at.name_short: скорочена назва, якщо вона є. Станом наedr_updated_at.status: поточний статус підприємства в ЄДР. Станом наedr_updated_at.registration_date: дата державної реєстрації. Станом наedr_updated_at.address: юридична адреса підприємства. Станом наedr_updated_at.activity: основний вид діяльності. Станом наedr_updated_at.edr_updated_at: дата останнього оновлення даних ЄДР у системі.created_at: дата створення ESG профілю підприємства в системі ESG SaveEcoBot.
results.timeline
link: посилання на запит таймлайна підприємства.total: загальна кількість записів у таймлайні, якщо його вже підготовлено.last_event_at: дата й час останньої події у таймлайні, якщо вони доступні.
results.sections
results.sections — це перелік секцій, доступних для підприємства. Частина секцій є простими недоменними блоками, наприклад адреси або контакти. Секції, у яких є groups, — це домени даних, наприклад air, water, waste, eia або sea.
results.sections.{section_key}
Простий блок секції, наприклад, адреси, контакти або види діяльності.
label: назва секції.total: кількість записів у секції.link: посилання на перелік записів.
results.sections.{section_key} з групами
Секція, у якій дані згруповані за підсекціями.
label: назва великої секції.groups: підсекції, згруповані за бізнес-логікою.
results.sections.{section_key}.groups.{group_key}
Простий підблок усередині великої секції.
label: назва підсекції.total: кількість записів у підсекції.total_pdf: кількість файлів у підсекції, якщо така метрика застосовується.link: посилання на перелік записів.
results.sections.{section_key}.groups.{group_key} з типами
Підблок усередині великої секції, у якому записи додатково згруповані за типами.
label: назва підсекції.total: загальна кількість записів у підсекції.total_pdf: загальна кількість файлів у підсекції, якщо така метрика застосовується.types[]: перелік типів усередині підсекції.types[].id: ідентифікатор типу.types[].label: назва типу.types[].total: кількість записів цього типу.types[].total_pdf: кількість файлів цього типу, якщо застосовується.types[].link: посилання на відфільтрований перелік.link: посилання на перелік записів.