У цьому розділі описані запити для роботи зі справами та документами, пов'язаними зі стратегічною екологічною оцінкою.
Перелік справ СЕО
GET /api/v1/enterprises/{registry_id}/sea-cases
Цей запит повертає справи зі стратегічної екологічної оцінки, які пов'язані з підприємством. Разом із переліком справ повертаються основні дані по кожній справі, кількість документів і посилання на вкладений запит з документами конкретної справи.
Параметр registry_id в адресі запиту є обов'язковим — це ідентифікатор підприємства.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/sea-cases" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Параметри пагінації
page: номер сторінки.
Поля відповіді
results.items[]
id: ідентифікатор справи.registry_id: реєстраційний номер справи.name: назва справи.published_at: дата публікації справи.region: регіон справи.is_countrywide: ознака того, що справа стосується всієї країни.documents_count: кількість документів у справі.links.details: посилання на деталі справи СЕО.links.documents: посилання на документи конкретної справи.
Деталі справи СЕО
GET /api/v1/enterprises/{registry_id}/sea-case-details/{case_id}
Цей запит повертає повні дані конкретної справи СЕО. У відповіді ви отримаєте той самий набір полів, що й у переліку справ, а також блок links для переходу до документів цієї справи.
Параметри registry_id і case_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. case_id — це ідентифікатор справи СЕО.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/sea-case-details/401" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
{
"results": {
"enterprise": { "type": "company", "registry_id": "00178353" },
"object": {
"id": 401,
"registry_id": "03-09-9021-24",
"name": "Стратегічна екологічна оцінка документа державного планування",
"published_at": "2025-02-10",
"region": "Київська область",
"is_countrywide": false,
"documents_count": 4,
"links": {
"documents": "https://esg.saveecobot.com/api/v1/enterprises/00178353/sea-cases/401/documents"
}
}
},
"stats": { "..." }
}
Поля відповіді
results.object
Поля об'єкта ті самі, що й у results.items[] в переліку справ СЕО.
results.object.links
documents: посилання на документи цієї справи.
Документи СЕО підприємства
GET /api/v1/enterprises/{registry_id}/sea-documents
Цей запит повертає документи СЕО, пов'язані з підприємством. Разом із кожним документом повертається короткий блок case, який вказує, до якої справи належить кожен запис.
Параметр registry_id в адресі запиту є обов'язковим — це ідентифікатор підприємства.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/sea-documents?document_type_id=1" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Параметри пагінації
page: номер сторінки.
Фільтри
document_type_id: тип документа. Доступні значення можна отримати в запиті Типи документів СЕО.
Поля відповіді
results.items[]
id: ідентифікатор документа.type_name: назва типу документа.name: назва документа.format: формат файла.size: розмір файла в байтах.uploaded_at: дата, коли файл було завантажено або оприлюднено в джерелі.downloaded_at: дата, коли файл був завантажений у систему ESG SaveEcoBot.links.download: посилання на завантаження документа.case: коротка інформація про справу, до якої належить документ.case.id: ідентифікатор справи.case.registry_id: реєстраційний номер справи.case.name: назва справи.case.region: регіон справи.case.published_at: дата публікації справи.
Документи справи СЕО
GET /api/v1/enterprises/{registry_id}/sea-cases/{case_id}/documents
Цей запит повертає документи конкретної справи СЕО. Разом із переліком документів повертається блок object з короткою інформацією про саму справу.
Параметри registry_id і case_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. case_id — це ідентифікатор справи СЕО.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/sea-cases/401/documents?document_type_id=1" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Фільтри
document_type_id: тип документа. Доступні значення можна отримати в запиті Типи документів СЕО.
Поля відповіді
results.object
id: ідентифікатор справи.registry_id: реєстраційний номер справи.name: назва справи.
results.items[]
Поля елемента ті самі, що й у глобальному списку документів, але без вкладеного object.
Завантаження документа СЕО
GET /api/v1/enterprises/{registry_id}/sea-documents/{document_id}/download
Цей запит повертає бінарний файл документа СЕО для завантаження.
Параметри registry_id і document_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. document_id — це ідентифікатор документа СЕО.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl -L "https://esg.saveecobot.com/api/v1/enterprises/00178353/sea-documents/81001/download" \
-H "Authorization: Bearer $ESG_API_TOKEN"
Приклад відповіді
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="sea-document.pdf"
