L'API de signature électronique Certyneo dans Postman
Importez la collection publique Certyneo dans Postman et testez chaque endpoint de l'API REST v1 — création d'enveloppes, envoi, suivi de statut, webhooks — avec des exemples de requêtes déjà renseignés.
Безплатна и публична колекция. Необходим е API ключ на Certyneo за изпълнение на заявките.
Защо да използвате колекцията Postman на Certyneo
Колекцията е разработена за разработчици, които искат да изследват API на Certyneo без да четат цялата документация преди да направят първата си заявка.
Готови за използване заявки
Всяка конечна точка на REST API v1 е документирана с пример за заявка и отговор, готови за изпълнение след като попълните вашия API ключ.
Тестови среди
Променлива на Postman средата съдържа вашия API ключ и основния URL, за лесно преминаване между вашите акаунти или среди.
Автоматично генерирана документация
Документацията на Postman на колекцията остава синхронизирана със спецификацията OpenAPI на API на Certyneo — няма разлика между това, което тестирате, и това, което е в производство.
Тестване без писане на код
Създайте плик, изпратете го и проследете статуса му директно от интерфейса на Postman, дори преди да интегрирате API в вашето приложение.
Какво обхваща колекцията
Общ преглед на групите на конечни точки, налични в публичната колекция.
| Група | Какво съдържа |
|---|---|
| Пликове | Създавайте, изпращайте, печелете, преглеждайте и отменяйте подписващ плик. |
| Документи | Качете документ или го импортирайте от URL (sourceUrl), преглед на статуса му. |
| Подписващи | Добавяне на получатели, определяне на техния ред на подписване и ниво (SES/AES). |
| Webhooks | Създаване и управление на абонаменти за eventi на подписване. |
| Масово изпращане | Изпращане на няколко плика в един запрос за кампании на подписване в голям обем. |
Колекцията е публична за четене: можете да я консултирате без профил, но изпълнението на запросите изисква валиден 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 спецификация на Certyneo API при всяка еволюция на REST API v1.
Мога ли да тествам webhook-ите от Postman?
Да, колекцията съдържа крайни точки за създаване и списък на вашите webhook абонаменти. За получаване на събития локално, използвайте HTTP тунелиращ сервис през време на вашите тестове.
Има ли цена за използване на Postman колекцията?
Не, само потреблението на самия API (създаване на пликове) се отчита от вашия план, точно както обикновено API повикване.
Да продължим
Тествайте Certyneo API в Postman
Публична колекция, безплатна, синхронизирана с нашата документация за разработчици.