API електронного підпису Certyneo в Postman
Імпортуйте загальнодоступну колекцію Certyneo в Postman та протестуйте кожен ендпоїнт REST API v1 — створення конвертів, відправлення, стеження за статусом, вебхуки — з уже заповненими прикладами запитів.
Безкоштовна та загальнодоступна колекція. Для виконання запитів необхідний ключ API Certyneo.
Чому використовувати колекцію Postman Certyneo
Колекція розроблена для розробників, які хочуть дослідити API Certyneo без читання всієї документації перед запуском першого запиту.
Готові до використання запити
Кожна кінцева точка REST API v1 задокументована з прикладом запиту та відповіді, готові до виконання після введення вашого ключа API.
Тестові середовища
Змінна середовища Postman містить ваш ключ API та базову URL-адресу для легкого перемикання між вашими обліковими записами або середовищами.
Автоматично створена документація
Документація Postman колекції залишається синхронізованою зі специфікацією OpenAPI API Certyneo — немає розбіжності між тим, що ви тестуєте, та тим, що знаходиться у виробництві.
Тестування без написання коду
Створіть конверт, надішліть його та стежте за його статусом прямо з інтерфейсу Postman, навіть перш ніж інтегрувати API у вашу програму.
Що охоплює колекція
Огляд груп кінцевих точок, доступних у публічній колекції.
| Група | Що вона містить |
|---|---|
| Конверти | Створювати, надсилати, наводити список, переглядати та скасовувати конверт підпису. |
| Документи | Завантажити документ або імпортувати його з URL-адреси (sourceUrl), переглянути його статус. |
| Підписанти | Додавати одержувачів, визначати порядок їхнього підпису та рівень (SES/AES). |
| Webhooks | Створювати та керувати підписками на події підпису. |
| Масове відправлення | Надсилати кілька конвертів в одному запиті для масових кампаній підпису. |
Колекція відкрита для читання: ви можете переглядати її без облікового запису, але виконання запитів вимагає дійсного ключа API Certyneo.
Почніть з колекцією за 4 кроки
Менше за 5 хвилин, щоб запустити ваш перший запит.
- 1
Імпортуйте публічну колекцію
З Postman відкрийте публічну колекцію Certyneo та натисніть на « Fork » або « Import », щоб скопіювати її у свій власний простір.
- 2
Створіть ключ API Certyneo
На панелі керування Certyneo відкрийте Параметри → Ключі API та створіть ключ, призначений для Postman.
- 3
Заповніть змінну середовища
Вставте ваш ключ API у змінну середовища колекції Postman, а також базову URL-адресу API.
- 4
Надішліть перший запит
Запустіть запит « Створити конверт » та стежте результат прямо в Postman.
Безпека та найкращі практики
Запити з колекції проходять через той самий API, що й ваша програма у виробництві: застосовуються ті самі правила безпеки.
- Усі запити передаються через HTTPS/TLS 1.2 мінімум.
- Кожен ключ API обмежений дозволами, які ви йому надаєте під час створення.
- Використовуйте спеціальний тестовий ключ для ваших спроб у Postman, окремо від вашого ключа виробництва.
- Скомпрометований або невикористаний ключ API відповідно відкликається одним кліком на панелі керування Certyneo.
Часто задаються питання
Чи потрібен платний план для використання колекції Postman ?
Ні. Колекція є публічною та безплатною. Обмеження вашого плану Certyneo (кількість конвертів, функціональність) застосовуються до виконаних запитів, як для будь-якого використання API.
Де знайти мій ключ API?
У вашій інформаційній панелі Certyneo в розділі Параметри → Ключі API. Створіть ключ, виділений для ваших тестів Postman.
Чи колекція актуальна з останньою версією API?
Так, колекція регенерується з офіційної специфікації OpenAPI API Certyneo при кожній еволюції REST API v1.
Чи можу я тестувати вебхуки з Postman?
Так, колекція містить точки доступу для створення та переліку ваших підписок вебхуків. Для отримання подій локально використовуйте сервіс HTTP-тунелю протягом часу ваших тестів.
Чи має використання колекції Postman вартість?
Ні, лише споживання самого API (створення конвертів) вираховується з вашого плану, точно як звичайний виклик API.
Щоб піти далі
Тестуйте API Certyneo в Postman
Публічна колекція, безплатна, синхронізована з нашою документацією розробників.