Перелік методів API по роботі з порталом EDIN ID

Всі запити нижче перерахованих API методів порталу EDIN ID направляються на адресу: https://id.edin.ua

Для підписання хеш(ів) та/або файлу пароль передається в зашифрованому вигляді.

Інтеграція підпису в облікову систему

1	Отримати і зберегти публічний ключ	GET /api/external/key
2	Підписати хеш ключем співробітника компанії	POST /api/external/company/sign
3	Підписати файл ключем співробітника компанії	POST /api/external/company/sign/file

Колекція Postman

Інтеграція управління ключами в облікову систему

1	Отримати інформацію про компанію	GET /api/external/company
2	Отримати інформацію про співробітника	GET /api/external/company/employee
3	Пошук ключів співробітника	POST /api/external/company/employee/pkeys/search
4	Пошук співробітників компанії	POST /api/external/company/employees/search
5	Пошук ключів компанії	POST /api/external/company/pkeys/search
6	Отримати інформацію про ключ	GET /api/external/company/pkey
7.1	Отримати документ компанії	GET /api/external/company/form
7.2	Отримати ідентифікацію співробітника	GET /api/external/company/employee/identification
7.3	Отримати документ ключа	GET /api/external/company/pkey/form
8	Додати співробітника	POST /api/external/company/employee
9.1	Створити чернетку ключа	POST /api/external/company/employee/pkey/generate/draft
9.2	Згенерувати PDF-форму для адміністратора компанії	PATCH /api/external/company/employee/pkey/generate/draft
9.3	Передати підписи PDF і активувати ключ	POST /api/external/company/employee/pkey/activation
10	Змінити статус ключа	POST /api/external/company/pkey/status
11	Змінити статус співробітника	POST /api/external/company/employee/status

Створення ключа складається з трьох запитів:

1. Створити чернетку ключа та отримати PDF для підпису співробітником.
2. Згенерувати PDF для підпису адміністратором компанії.
3. Передати detached-підписи всіх PDF і активувати ключ або передати його на активацію КНЕДП.

Рекомендований сценарій створення та активації ключа:

1. Перевірити компанію методом 1.
2. Якщо співробітника ще немає – створити його методом 8.
3. Перевірити співробітника методом 2.
4. Викликати метод 9.1 і отримати pKey.uuid та employee PDF-форми.
5. Співробітник підписує PDF-форми з відповіді 9.1 detached-підписом.
6. Викликати метод 9.2 з pKeyUuid та adminIpn і отримати admin PDF-форми.
7. Адміністратор/суперадміністратор підписує PDF-форми з відповіді 9.2 detached-підписом.
8. Викликати метод 9.3, передавши keyUuid, activate і map підписів за всіма отриманими formType.
9. Отримати оновлений ESSPrivateKey зі статусом ACTIVATED або COMPANY_ADMIN_APPROVED.