Повідомлення підприємства

У цьому розділі описані запити для роботи з повідомленнями підприємства в межах конкретного домену, а також з пов'язаними файлами таких повідомлень.

Перелік повідомлень

GET /api/v1/enterprises/{registry_id}/notices/{domain}

Цей запит повертає повідомлення підприємства в межах одного домену разом із базовими даними про публікацію та об'єкт. У відповіді ви отримаєте дати публікації, посилання на файли й, за наявності доступу, координати.

Параметри registry_id і domain в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства.

Доступні значення domain можна отримати в запиті Домени даних.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/notices/air?notice_type_id=1" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "domain": { "slug": "air", "label": "Повітря" },
    "items": [
      {
        "id": 88,
        "type_id": 1,
        "type_name": "Заява про наміри отримати дозвіл на викиди",
        "authority_name": "Міндовкілля",
        "name": "Повідомлення про наміри",
        "description_lines": ["Оприлюднено для громадського обговорення"],
        "address": "Україна, Київська область, місто Київ",
        "object_name": "Промисловий майданчик",
        "emissions_list": "оксид вуглецю, діоксид азоту",
        "published_at": "2025-04-01",
        "expire_at": "2025-05-01",
        "publisher_name": "Офіційний вебсайт",
        "recognized_by": "Gemini",
        "files_count": 1,
        "links": {
          "details": "https://esg.saveecobot.com/api/v1/enterprises/00178353/notice-details/88",
          "files": "https://esg.saveecobot.com/api/v1/enterprises/00178353/notice-files/88"
        },
        "coordinates": null
      }
    ]
  },
  "stats": { "..." }
}

Параметри пагінації

page: номер сторінки.

Фільтри

year: рік публікації або актуальності.
notice_type_id: ідентифікатор типу повідомлення. Доступні значення можна отримати в запиті Типи повідомлень.

Поля відповіді

`results.items[]`

id: ідентифікатор повідомлення.
type_id: ідентифікатор типу повідомлення.
type_name: назва типу повідомлення.
authority_name: орган або джерело повідомлення.
name: назва повідомлення.
description_lines[]: короткий опис повідомлення окремими рядками.
address: адреса об'єкта.
object_name: назва об'єкта або майданчика.
emissions_list: перелік речовин або інших сутностей, якщо він є.
published_at: дата публікації.
expire_at: дата завершення дії або строку публікації.
publisher_name: назва публікатора.
recognized_by: назва сервісу розпізнавання, якщо повідомлення було розпізнано автоматично.
files_count: кількість файлів.
links.details: посилання на деталі повідомлення.
links.files: посилання на перелік файлів.
coordinates: координати адреси, якщо доступ до них дозволений для ключа.
coordinates.latitude: широта.
coordinates.longitude: довгота.

Деталі повідомлення

GET /api/v1/enterprises/{registry_id}/notice-details/{notice_id}

Цей запит повертає повні дані конкретного повідомлення. У відповіді ви отримаєте той самий набір полів, що й у переліку повідомлень, а також блок links для переходу до пов'язаних файлів.

Параметри registry_id і notice_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. notice_id — це ідентифікатор повідомлення.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/notice-details/88" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "object": {
      "id": 88,
      "type_id": 1,
      "type_name": "Заява про наміри отримати дозвіл на викиди",
      "authority_name": "Міндовкілля",
      "name": "Повідомлення про наміри",
      "description_lines": ["Оприлюднено для громадського обговорення"],
      "address": "Україна, Київська область, місто Київ",
      "object_name": "Промисловий майданчик",
      "emissions_list": "оксид вуглецю, діоксид азоту",
      "published_at": "2025-04-01",
      "expire_at": "2025-05-01",
      "publisher_name": "Офіційний вебсайт",
      "recognized_by": "Gemini",
      "files_count": 1,
      "coordinates": null,
      "links": {
        "files": "https://esg.saveecobot.com/api/v1/enterprises/00178353/notice-files/88"
      }
    }
  },
  "stats": { "..." }
}

Поля відповіді

`results.object`

Поля об'єкта ті самі, що й у results.items[] в переліку повідомлень.

`results.object.links`

files: посилання на окремий перелік файлів повідомлення, якщо файли є.

Файли повідомлення

GET /api/v1/enterprises/{registry_id}/notice-files/{notice_id}

Цей запит повертає файли конкретного повідомлення. Разом із переліком файлів items повертається блок object з короткою інформацією про саме повідомлення.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/notice-files/88" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

Приклад відповіді

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "object": {
      "type": "notice",
      "id": 88,
      "type_id": 1,
      "type_name": "Заява про наміри отримати дозвіл на викиди",
      "name": "Повідомлення про наміри",
      "object_name": "Промисловий майданчик",
      "published_at": "2025-04-01"
    },
    "items": [
      {
        "id": 1,
        "name": "notice.pdf",
        "description": "Основний документ",
        "format": "pdf",
        "size": 55201,
        "uploaded_at": "2025-04-01T09:30:00+00:00",
        "downloaded_at": "2025-04-01T09:40:00+00:00",
        "links": {
          "download": "https://esg.saveecobot.com/api/v1/enterprises/00178353/notice-files/88/download/1"
        }
      }
    ]
  },
  "stats": { "..." }
}

Поля відповіді

`results.object`

type: тип об'єкта. Для цього запиту використовується значення notice.
id: ідентифікатор повідомлення.
type_id: ідентифікатор типу повідомлення.
type_name: назва типу повідомлення.
name: назва повідомлення.
object_name: назва об'єкта.
published_at: дата публікації повідомлення.

`results.items[]`

id: ідентифікатор файла повідомлення.
name: назва файла.
description: короткий опис файла.
format: формат файла.
size: розмір файла в байтах.
uploaded_at: дата, коли файл було завантажено або оприлюднено в джерелі.
downloaded_at: дата, коли файл був завантажений у систему ESG SaveEcoBot.
links.download: посилання на завантаження файла.

Завантаження файла повідомлення

GET /api/v1/enterprises/{registry_id}/notice-files/{notice_id}/download/{file_id}

Цей запит повертає бінарний файл повідомлення для завантаження.

Параметри registry_id, notice_id і file_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. notice_id — це ідентифікатор повідомлення. file_id — це ідентифікатор файла повідомлення.

Приклад запиту

$ ESG_API_TOKEN="your_api_token"
$ curl -L "https://esg.saveecobot.com/api/v1/enterprises/00178353/notice-files/88/download/1" \
  -H "Authorization: Bearer $ESG_API_TOKEN"

Приклад відповіді

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="notice-2025-03-a.pdf"

Перелік повідомлень

Приклад запиту

Приклад відповіді

Параметри пагінації

Фільтри

Поля відповіді

results.items[]

Деталі повідомлення

Приклад запиту

Приклад відповіді

Поля відповіді

results.object

results.object.links

Файли повідомлення

Приклад запиту

Приклад відповіді

Поля відповіді

results.object

results.items[]

Завантаження файла повідомлення

Приклад запиту

Приклад відповіді

Візьміть участь в тестуванні ESG профілю підприємства у системі SaveEcoBot

`results.items[]`

`results.object`

`results.object.links`

`results.object`

`results.items[]`