Робота з API порталу EDIN ID
Колекцію Postman можна скачати в сторінці "Перелік методів АРІ"
Перелік методів API по роботі з порталом EDIN ID
Всі запити нижче перерахованих API методів порталу EDIN ID направляються на адресу: https://id.ed...
Шифрування пароля за допомогою відкритого ключа RSA
Приклад для Postman (js) Функції для шифрування /** * Encrypt data with RSA public key * @param...
Помилки при роботі з API
Помилки повертаються у JSON без envelope: { "type": "employee_not_found" } Загальні помилки Код...
Методи API
Отримати і зберегти публічний ключ GET /api/external/key
REQUEST URL Метод запиту GET URL запиту /api/external/key Authorization ...
Підписати ключем співробітника компанії POST /api/external/company/sign
REQUEST URL Метод запиту POST URL запиту /api/external/company/sign Headers Authorization x-s...
Підписати файл ключем співробітника компанії POST /api/external/company/sign/file
REQUEST URL Метод запиту POST URL запиту /api/external/company/sign/file Authorization Auth typ...
Отримати інформацію про компанію GET /api/external/company
REQUEST URL Метод запиту GET URL запиту /api/external/company URL параметри companyCode (обов’язк...
Отримати інформацію про співробітника GET /api/external/company/employee
REQUEST URL Метод запиту GET URL запиту /api/external/company/employee URL параметри companyCode ...
Пошук ключів співробітника POST /api/external/company/employee/pkeys/search
REQUEST URL Метод запиту POST URL запиту /api/external/company/employee/pkeys/search URL параметр...
Пошук співробітників компанії POST /api/external/company/employees/search
REQUEST URL Метод запиту POST URL запиту /api/external/company/employees/search URL параметри com...
Пошук ключів компанії POST /api/external/company/pkeys/search
REQUEST URL Метод запиту POST URL запиту /api/external/company/pkeys/search URL параметри company...
Отримати інформацію про ключ GET /api/external/company/pkey
REQUEST URL Метод запиту GET URL запиту /api/external/company/pkey URL параметри companyCode (обо...
Отримання документа компанії GET /api/external/company/form
REQUEST URL Метод запиту GET URL запиту /api/external/company/form URL параметри companyCode (обо...
Отримати ідентифікацію співробітника GET /api/external/company/employee/identification
REQUEST URL Метод запиту GET URL запиту /api/external/company/employee/identification URL парамет...
Отримати документ ключа GET /api/external/company/pkey/form
REQUEST URL Метод запиту GET URL запиту /api/external/company/pkey/form URL параметри companyCode...
Додати співробітника POST /api/external/company/employee
REQUEST URL Метод запиту POST URL запиту /api/external/company/form URL параметри companyCode (об...
Створити чернетку ключа для співробітника POST /api/external/company/employee/pkey/generate/draft
REQUEST URL Метод запиту POST URL запиту /api/external/company/employee/pkey/generate/draft URL п...
Згенерувати PDF-форму для адміністратора компанії PATCH /api/external/company/employee/pkey/generate/draft
Цей метод можна викликати повторно. У такому випадку admin-форми будуть перестворені, а попередні...
Передати підписи PDF і активувати ключ POST /api/external/company/employee/pkey/activation
REQUEST URL Метод запиту POST URL запиту /api/external/company/employee/pkey/activation URL парам...
Змінити статус ключа POST /api/external/company/pkey/status
Метод змінює статус ключа компанії/співробітника та одразу формує, підписує і зберігає PDF-підтве...
Змінити статус співробітника POST /api/external/company/employee/status
Метод змінює статус співробітника компанії. Якщо дія вимагає каскадної зміни статусів ключів спів...
Верифікувати підпис на файлі POST /api/external/company/sign/file/verify
REQUEST URL Метод запиту POST URL запиту /api/external/company/sign/file/verify URL параметри for...
Отримати інформацію про сертифікат GET /api/external/company/key/certificate
REQUEST URL Метод запиту GET URL запиту /api/external/company/key/certificate URL параметри key (...
Створення компанії POST /api/external/company/create
Метод створює компанію у статусі DRAFT, з договором-офертою OFFER, створює чернетку ключа супер...
Об'єкти API
Довідник enum значень
ESSRegFormType Для запитів на документи formType передається як enum name: name code Опис викор...
Об'єкт ESSCompany
Опис параметрів об’єкта Поле Тип Опис id number Внутрішній ідентифікатор компанії. fullName strin...
Об'єкт ESSUser
Опис параметрів об’єкта Поле Формат Опис id number Внутрішній ідентифікатор користувача. login st...
Обект ESSPrivateKey
Опис параметрів об’єкта Поле Тип Опис id number Внутрішній ідентифікатор ключа. name string Назва...
Об'єкт ESSCAUser
Опис параметрів об’єкта Поле Формат Опис id number Внутрішній ID CA user. userId number Внутрішні...
Об'єкт ESSCAUserInfo
Опис параметрів об'єкта Поле Формат Опис commonName string/null CN. userCode string/null Код кори...
Об'єкт ESSPKRequest
Опис параметрів об'єкта Поле Формат Опис privateKeyId number Внутрішній ID ключа. type enum SIGNA...
Об'єкт ESSCertificate
Опис параметрів об'єкта Поле Формат Опис type enum SIGNATURE, ENCRYPTION, ECDSA. status enum Ст...
Об'єкт ESSUserIdentification
Опис параметрів об'єкта Поле Формат Опис type enum Тип ідентифікації. complete enum YES або NO. ...
Об'єкт ESSPrivateKeysQuery
Опис параметрів об'єкта Параметр Формат Тип 1 Опис nameQuery string O Пошук за назвою ключа. comp...
Об'єкт ESSUsersQuery
Опис параметрів об'єкта Параметр Формат Тип 1 Опис search string O Пошук за ПІБ, ІПН або телефоно...
Об'єкт EndUserCertificateInfoEx
class EndUserCertificateInfoEx { isFilled: boolean; version: number; issuer: string...