为什么使用 Certyneo Postman 合集
该合集专为想要探索 Certyneo API 但不想在发送第一个请求前阅读全部文档的开发者而设计。
开箱即用的请求
API REST v1 的每个端点都附带请求和响应示例的文档，在输入您的 API 密钥后即可执行。
测试环境
Postman 环境变量包含您的 API 密钥和基础 URL，便于在账户或环境之间轻松切换。
自动生成的文档
集合的 Postman 文档与 Certyneo API 的 OpenAPI 规范保持同步——您测试的内容与生产环境中的内容没有偏差。
无需编写代码即可测试
直接在 Postman 界面中创建信封、发送信封并跟踪其状态，甚至在将 API 集成到应用程序之前。
集合涵盖的内容
公开集合中可用的端点组概览。
| 组 | 内容概览 |
|---|---|
| 信封 | 创建、发送、列表、查看和取消签名信封。 |
| 文档 | 上传文档或从 URL (sourceUrl) 导入，查看其状态。 |
| 签署人 | 添加收件人，定义其签署顺序和级别 (SES/AES)。 |
| Webhooks | 创建和管理签名事件订阅。 |
| 批量发送 | 在单个请求中发送多个信封，用于大批量签名活动。 |
该集合为公开可读：您无需账户即可查看，但执行请求需要有效的 Certyneo API 密钥。
四步开始使用集合
启动您的第一个请求只需不到5分钟。
- 1
导入公开集合
从 Postman 中，打开 Certyneo 公开集合，点击「Fork」或「Import」将其复制到您自己的空间。
- 2
生成 Certyneo API 密钥
在您的 Certyneo 仪表板中，打开设置 → API 密钥，创建一个专用于 Postman 的密钥。
- 3
填写环境变量
将您的 API 密钥粘贴到 Postman 集合的环境变量中，并填入 API 的基础 URL。
- 4
发送第一个请求
启动「创建信封」请求，直接在 Postman 中查看结果。
安全和最佳实践
该集合中的请求使用与您生产应用相同的 API：相同的安全规则适用。
- 所有请求都通过至少 HTTPS/TLS 1.2 进行传输。
- 每个 API 密钥仅限于创建时您授予的权限。
- 为 Postman 测试使用专门的测试密钥，与生产密钥分开。
- 被泄露或未使用的 API 密钥可以从您的 Certyneo 仪表板一键撤销。
常见问题
使用 Postman 集合是否需要付费计划？
不需要。该集合是公开且免费的。您的 Certyneo 计划限制（信封数量、功能）适用于执行的请求，就像 API 的任何其他使用一样。
在哪里找到我的 API 密钥？
在您的 Certyneo 仪表板中，依次点击「设置」→「API 密钥」。为您的 Postman 测试创建一个专用密钥。
该集合是否与最新版本的 API 保持同步？
是的，该集合在每次 API REST v1 更新时都会根据 Certyneo API 的官方 OpenAPI 规范重新生成。
我可以在 Postman 中测试 webhook 吗？
可以，该集合包含用于创建和列出 webhook 订阅的端点。要在本地接收事件，请在测试期间使用 HTTP 隧道服务。
使用 Postman 集合是否有成本？
没有，只有 API 本身的使用（创建信封）会从您的计划中扣除，就像普通 API 调用一样。
为了更进一步
在 Postman 中测试 Certyneo API
公开集合，免费，与我们的开发者文档同步。