API 密钥在开发者、API 密钥下;工作流 ID 在工作流页面;Webhook 签名密钥属于每个端点,位于开发者、Webhooks 下。
你需要从控制台获取三个值。API 密钥在开发者 → API 密钥下创建。工作流 ID 从工作流页面复制。Webhook 签名密钥属于开发者 → Webhooks 下的每个端点,你可以随时通过显示再次查看。三个值请取自同一个应用和同一个环境,即生产或沙盒。
入门应用或 AI 生成的项目通常会列出 DIDIT_API_KEY、DIDIT_WORKFLOW_ID 和 DIDIT_WEBHOOK_SECRET 之类的环境变量。这些名称属于那个应用:Didit 不会替你设置。下表说明每个值的来源。
#每个值在哪里
| 值 | 在哪里获取 | 需要知道什么 |
|---|---|---|
| API 密钥 | 开发者 → API 密钥,然后点击创建密钥(每个应用也都有一个主要密钥) | 完整的密钥只在你创建或轮换密钥时显示一次,所以请在那时把它复制到你的密钥管理器中。生产应用和沙盒应用的密钥不同:沙盒密钥永远不会创建生产核验。请通过 x-api-key 请求头发送,且只从你的服务器发送 |
| 工作流 ID | 身份验证 → 工作流:打开该行的菜单并选择复制工作流 ID(预览面板中有同样的按钮) | 每个工作流在每个应用中都有自己的 ID。工作流的副本会获得新的 ID |
| Webhook 签名密钥 | 开发者 → Webhooks,打开端点,然后找到其签名密钥并点击显示 | 每个端点一个密钥,而不是每个应用一个。显示前会要求你确认是本人操作,之后密钥会在 60 秒内再次隐藏。你可以在需要时再次显示 |
| API 基础 URL | 不在控制台中:由 docs.didit.me 给出 | https://verification.didit.me 提供验证 API(会话、工作流、名单、Webhooks),使用 x-api-key 请求头进行认证。参见 API 认证 |
API 密钥和签名密钥是不同的值。API 密钥用于认证你对 Didit 的调用;签名密钥用于核对某个 Webhook 确实来自 Didit。用其中一个代替另一个,会得到 401 或签名不匹配。
#我还能再次看到 Webhook 签名密钥吗?
可以。打开开发者 → Webhooks,打开端点并点击显示。确认是你本人后,密钥最多显示 60 秒。如果显示对你是灰色的,请询问有权限的队友或联系支持团队。如果你想要一个新密钥,请改为轮换:旧密钥会继续有效 24 小时。更多内容参见通过 Webhook 获取核验结果。
#检查你的设置
- 匹配环境
先在控制台中选择应用以及生产或沙盒环境,然后在那里复制密钥、工作流 ID,并创建 Webhook 端点。沙盒密钥搭配生产工作流 ID,是出现 401 或 403 的常见原因。
- 把值放进服务器配置
把它们存为服务器端密钥。永远不要把 API 密钥或签名密钥放进前端代码、公开仓库或移动应用。
- 创建会话
使用你的密钥和工作流 ID 调用
https://verification.didit.me上的创建会话端点。401 表示密钥错误、已过期或已被撤销;工作流上的 403 通常表示该密钥属于另一个应用。参见 API 错误。 - 发送测试事件
在开发者 → Webhooks中打开你的端点,点击发送测试事件。你的服务器应使用签名密钥校验签名,并返回 2xx。如果什么都没收到,参见 Webhook 一直没有到达。
#相关文章
- 管理你的 API 密钥
- 通过 Webhook 获取核验结果
- 创建核验工作流
- API 认证(docs.didit.me)
还没解决?和真人聊聊。
请附上你的组织 ID 以及你要咨询的会话 ID。