快速开始
集成 / SDK
用户验证
企业验证
交易监控
更新日志在引入限定访问权限之前创建的密钥保留完整访问权限。
在你编辑其访问权限之前，它们不会有任何变化。
在哪里找到它们
在业务控制台中选择你的应用，然后打开 Developers -> API keys。 列表显示应用的每个密钥，包括其状态、过去 30 天的请求数、创建者、访问权限以及最近一次使用时间。 点击某个密钥可在右侧预览，或打开其完整页面，查看用量、访问权限、近期请求、快速入门代码片段及其活动记录。 密钥只属于一个应用，且仅对该应用有效。 密钥继承应用的环境：沙盒应用的密钥永远不会产生计费验证。重定向 URL 与允许的域名
打开 Developers > API keys > Redirects and domains，为所选应用和环境设置两个列表。
当 允许的域名 列表中有条目时，创建会话会以
400 错误拒绝不在其中任何一个域名上的 callback。
列表为空表示不做任何限制。
服务器到服务器的调用不受影响。
创建密钥
1
详情
以将使用该密钥的服务为其命名，并选择过期时间：永不过期、30 天、90 天、一年，或您指定的日期。
密钥过期后，将于当天 UTC 时间结束时失效。
2
访问权限
先选择一个预设，再按资源进行细化设置。
该密钥的权限永远不会超出此范围。
3
检查
在您把密钥交给他人之前，控制台会明确列出该密钥能做什么、不能做什么。
4
机密值
复制机密值并保存到您的密钥管理器中。
完整机密值只会显示这一次。
如果丢失，请轮换该密钥以获取新密钥。
预设
资源
读取权限涵盖对某个资源的GET 请求；写入权限还涵盖 POST、PUT、PATCH 和 DELETE。
带有自定义访问权限的密钥可以访问公共 API：会话、用户、企业、交易、工作流和 Webhook endpoint，以及独立检查。
仅供 Business Console 使用的 endpoint 会向该密钥返回
403；这些 endpoint 需要完全访问权限的密钥。
如果密钥没有媒体文件读取权限，它收到的会话决策中，每个图像、视频和 PDF 的 URL 都会被设为 null，而 PDF 报告 endpoint 会返回 403。
如果密钥没有会话写入权限，它永远不会收到会话的验证链接或会话 token，因为持有者可以代表终端用户完成验证。这些字段会返回 null。
同理，使用 send_verification_link: true 创建用户时，除了用户写入权限外，还需要会话写入权限，因为该操作会创建会话并通过邮件发送其链接。
如果没有该权限，调用会返回 403，且不会创建任何内容。
限制
限制为部分工作流或仅已通过会话的密钥，可以在可应用限制的会话 endpoint 上使用。
它无法访问用户、公司、交易或分析，也无法运行独立检查。
API 如何响应受限密钥
会话列表只返回密钥的限制允许的会话。
编辑访问权限
打开密钥的菜单、预览或页面，然后选择编辑访问权限。 更改预设、资源、限制或过期时间，然后在提交前仅检查发生变化的内容，包括变更前和变更后的对比。 密钥的机密值保持不变，因此无需重新部署，新的访问权限会在一分钟内生效。 主机密值始终拥有完全访问权限，且无法编辑。轮换密钥
轮换会替换密钥的机密值。 新的机密值只显示一次，当前机密值会继续有效 24 小时，以便您在不中断服务的情况下部署新的机密值。 之后，使用旧机密值的每个请求都会返回401。
主机密值的轮换方式相同，同样有 24 小时的重叠期。
撤销密钥
撤销会立即停止密钥：使用该密钥的每个请求都会返回401。
此操作无法撤销。
主机密值无法撤销；请改为轮换它。