Реєстри підприємства

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

Перелік записів реєстрів

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

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

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

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

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

$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/registries/sanctions?registry_type_id=5" \
  -H "Authorization: Bearer $ESG_API_TOKEN" \
  -H 'Accept: application/json'

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "domain": { "slug": "sanctions", "label": "Санкції" },
    "items": [
      {
        "id": 25,
        "type_id": 12,
        "type_name": "Державний реєстр санкцій РНБО (юридичні особи)",
        "registry_id": "NSDC-001",
        "authority_name": "РНБО",
        "name": "Санкційний запис",
        "description_lines": ["Рішення РНБО"],
        "address": null,
        "status": "чинний",
        "registry_year": 2025,
        "registry_date": "2025-02-01",
        "is_active": true,
        "files_count": 1,
        "links": {
          "details": "https://esg.saveecobot.com/api/v1/enterprises/00178353/registry-details/25",
          "files": "https://esg.saveecobot.com/api/v1/enterprises/00178353/registry-files/25"
        },
        "data": [
          {
            "key": "sanction_term",
            "label": "Строк дії санкції",
            "value": "10 років"
          }
        ],
        "coordinates": null
      }
    ],
    "pagination": {
      "current_page": 1,
      "per_page": 20,
      "total": 1,
      "last_page": 1
    }
  },
  "stats": { "..." }
}

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

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

Фільтри

year: рік запису, якщо він використовується для цього домену.
registry_type_id: ідентифікатор типу реєстру. Доступні значення можна отримати в запиті Типи реєстрів.

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

`results.items[]`

id: ідентифікатор запису реєстру.
type_id: ідентифікатор типу реєстру.
type_name: назва типу реєстру.
registry_id: реєстраційний номер або номер запису.
authority_name: орган або джерело, яке веде цей реєстр.
name: назва запису.
description_lines[]: короткий опис запису у вигляді окремих рядків.
address: адреса, якщо вона є в записі.
status: поточний статус запису.
registry_year: рік, до якого належить запис.
registry_date: дата запису або дата набрання чинності.
is_active: ознака актуальності запису.
files_count: кількість пов'язаних файлів.
links.details: посилання на деталі запису реєстру.
links.files: посилання на перелік файлів.
data[]: додаткові структуровані дані. Для більшості реєстрів це null, а для частини санкційних записів — масив.
data[].key: код.
data[].label: назва.
data[].value: значення.
coordinates: координати адреси, якщо доступ до них дозволений для ключа.
coordinates.latitude: широта.
coordinates.longitude: довгота.

Деталі запису реєстру

GET /api/v1/enterprises/{registry_id}/registry-details/{registry_record_id}

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

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

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

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

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "object": {
      "id": 25,
      "type_id": 12,
      "type_name": "Державний реєстр санкцій РНБО (юридичні особи)",
      "registry_id": "NSDC-001",
      "authority_name": "РНБО",
      "name": "Санкційний запис",
      "description_lines": ["Рішення РНБО"],
      "address": null,
      "status": "чинний",
      "registry_year": 2025,
      "registry_date": "2025-02-01",
      "is_active": true,
      "files_count": 1,
      "data": [
        {
          "key": "sanction_term",
          "label": "Строк дії санкції",
          "value": "10 років"
        }
      ],
      "coordinates": null,
      "links": {
        "files": "https://esg.saveecobot.com/api/v1/enterprises/00178353/registry-files/25"
      }
    }
  },
  "stats": { "..." }
}

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

`results.object`

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

`results.object.links`

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

Файли запису реєстру

GET /api/v1/enterprises/{registry_id}/registry-files/{registry_record_id}

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

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

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

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

{
  "results": {
    "enterprise": { "type": "company", "registry_id": "00178353" },
    "object": {
      "type": "registry",
      "id": 25,
      "registry_id": "NSDC-001",
      "type_id": 12,
      "type_name": "Державний реєстр санкцій РНБО (юридичні особи)",
      "name": "Санкційний запис"
    },
    "items": [
      {
        "id": 1,
        "type_name": "PDF",
        "name": "registry-record.pdf",
        "format": "pdf",
        "size": 41234,
        "uploaded_at": "2025-02-01T10:00:00+00:00",
        "downloaded_at": "2025-02-01T10:15:00+00:00",
        "links": {
          "download": "https://esg.saveecobot.com/api/v1/enterprises/00178353/registry-files/25/download/1"
        }
      }
    ]
  },
  "stats": { "..." }
}

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

`results.object`

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

`results.items[]`

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

Завантаження файла запису реєстру

GET /api/v1/enterprises/{registry_id}/registry-files/{registry_record_id}/download/{file_id}

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

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

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

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

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

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="registry-record.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[]`