У цьому розділі описані запити для роботи із сертифікатами, посвідченнями та свідоцтвами підприємства, їхніми строками дії, статусами та пов'язаними файлами. Далі для стислості в описі використовується термін сертифікати.
Перелік сертифікатів
GET /api/v1/enterprises/{registry_id}/certificates/{domain}
Цей запит повертає сертифікати підприємства в межах одного домену, зокрема посвідчення, свідоцтва та інші подібні записи. У відповіді ви отримаєте основні реквізити сертифіката, строки дії, статус і посилання на пов'язані файли, якщо вони є.
Параметри registry_id і domain в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства.
Доступні значення domain можна отримати в запиті Домени даних.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/certificates/forest?certificate_type_id=1" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Параметри пагінації
page: номер сторінки.
Фільтри
year: рік сертифіката.certificate_type_id: ідентифікатор типу сертифіката. Доступні значення можна отримати в запиті Типи сертифікатів.
Поля відповіді
results.items[]
id: ідентифікатор сертифіката.type_id: ідентифікатор типу сертифіката.type_name: назва типу сертифіката.registry_id: номер сертифіката або реєстраційний номер.authority_name: орган або джерело сертифіката.name: назва сертифіката.description_lines[]: короткий опис сертифіката окремими рядками.status: текстовий статус сертифіката.issued_at: дата видачі.valid_from: дата початку дії.valid_to: дата завершення дії.is_active: ознака чинності сертифіката.files_count: кількість пов'язаних файлів.links.details: посилання на деталі сертифіката.links.files: посилання на окремий перелік файлів.
Деталі сертифіката
GET /api/v1/enterprises/{registry_id}/certificate-details/{certificate_id}
Цей запит повертає повні дані конкретного сертифіката. У відповіді ви отримаєте той самий набір полів, що й у переліку сертифікатів, а також блок links для переходу до пов'язаних файлів.
Параметри registry_id і certificate_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. certificate_id — це ідентифікатор сертифіката.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/certificate-details/1" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Поля відповіді
results.object
Поля об'єкта ті самі, що й у results.items[] в переліку сертифікатів.
results.object.links
files: посилання на окремий перелік файлів сертифіката, якщо файли є.
Файли сертифіката
GET /api/v1/enterprises/{registry_id}/certificate-files/{certificate_id}
Цей запит повертає файли конкретного сертифіката. Разом із переліком файлів повертається блок object з короткою інформацією про сам сертифікат.
Параметри registry_id і certificate_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. certificate_id — це ідентифікатор сертифіката.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl "https://esg.saveecobot.com/api/v1/enterprises/00178353/certificate-files/1" \
-H "Authorization: Bearer $ESG_API_TOKEN" \
-H 'Accept: application/json'
Приклад відповіді
Поля відповіді
results.object
type: тип об'єкта. Для цього запиту використовується значенняcertificate.id: ідентифікатор сертифіката.registry_id: номер сертифіката або реєстраційний номер.type_id: ідентифікатор типу сертифіката.type_name: назва типу сертифіката.name: назва сертифіката.
results.items[]
id: ідентифікатор файла сертифіката.type_id: ідентифікатор типу файла.type_name: назва типу файла.name: назва файла.description: короткий опис файла.format: формат файла.size: розмір файла в байтах.uploaded_at: дата, коли файл було завантажено або оприлюднено в джерелі.downloaded_at: дата, коли файл був завантажений у систему ESG SaveEcoBot.links.download: посилання на завантаження файла.
Завантаження файла сертифіката
GET /api/v1/enterprises/{registry_id}/certificate-files/{certificate_id}/download/{file_id}
Цей запит повертає бінарний файл сертифіката для завантаження.
Параметри registry_id, certificate_id і file_id в адресі запиту є обов'язковими. registry_id — це ідентифікатор підприємства. certificate_id — це ідентифікатор сертифіката. file_id — це ідентифікатор файла сертифіката.
Приклад запиту
$ ESG_API_TOKEN="your_api_token"
$ curl -L "https://esg.saveecobot.com/api/v1/enterprises/00178353/certificate-files/1/download/1" \
-H "Authorization: Bearer $ESG_API_TOKEN"
Приклад відповіді
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="certificate-1.pdf"
