API электронной подписи Certyneo в Postman
Импортируйте публичную коллекцию Certyneo в Postman и протестируйте каждый endpoint REST API v1 — создание конвертов, отправку, отслеживание статуса, webhooks — с уже заполненными примерами запросов.
Бесплатная и публичная коллекция. Для выполнения запросов требуется API-ключ Certyneo.
Зачем использовать коллекцию Postman Certyneo
Коллекция разработана для разработчиков, которые хотят исследовать API Certyneo без необходимости читать всю документацию перед отправкой первого запроса.
Готовые к использованию запросы
Каждая точка входа REST API v1 документирована с примером запроса и ответа, готовая к выполнению после ввода вашего ключа API.
Тестовые окружения
Переменная окружения Postman содержит ваш ключ API и базовый URL для легкого переключения между вашими аккаунтами или окружениями.
Автоматически генерируемая документация
Документация Postman коллекции остаётся синхронизирована со спецификацией OpenAPI API Certyneo — отсутствует разрыв между тем, что вы тестируете, и тем, что находится в production.
Тестирование без написания кода
Создавайте конверт, отправляйте его и отслеживайте его статус прямо из интерфейса 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?
Да, коллекция содержит endpoints для создания и получения списка ваших подписок вебхуков. Для получения событий локально используйте сервис HTTP-туннеля на время ваших тестов.
Использование коллекции Postman имеет стоимость?
Нет, только потребление самого API (создание конвертов) вычитается из вашего плана, точно так же как обычный вызов API.
Чтобы пойти дальше
Тестируйте API Certyneo в Postman
Публичная коллекция, бесплатная, синхронизированная с нашей документацией для разработчиков.