API密钥

在ProcessMind中管理API密钥

要与ProcessMind的API集成，您需要创建和管理API密钥。了解如何生成、使用和保护API密钥。

在ProcessMind账户设置中，进入“API Keys”部分。您可以点击新建环境API密钥按钮创建新的API密钥。请为密钥命名，以便日后识别。

创建API密钥

您可以为不同的应用或服务创建多个API密钥。每个密钥都可以独立管理，您可以按需撤销某个密钥，而不会影响其他集成。 密钥生成后，请立即复制并妥善保存。出于安全原因，密钥在创建过程中只会显示一次。

组织API密钥

组织管理员也可以在同一页面创建组织API密钥。与环境密钥不同，组织密钥可用于该组织的所有环境（租户），因此一个集成即可服务所有环境。组织密钥可用于：

• 配置环境API密钥：通过External API创建、更新和删除租户范围内的密钥（/v1/tenant/{tenantId}/api-keys）。
• 生成一次性登录链接：让用户从您的产品直接进入ProcessMind，并自动完成身份验证（/v1/tenant/{tenantId}/users/{userId}/login-token）。

权限范围

权限范围	授予权限
read	读取租户数据（list/get端点）。默认启用。
write	创建、更新和删除租户数据。默认启用。
uploadData	请求数据表的预签名上传URL。默认启用。
sessions	生成一次性登录交接令牌。默认关闭。

仅为需要登录交接的密钥启用sessions，并像保护密码一样保护这些密钥：生成的令牌可让用户无需输入密码即可登录。组织密钥可为组织内所有环境的用户生成令牌；环境密钥只能为其所属环境的用户生成令牌。

一次性登录交接

POST /v1/tenant/{tenantId}/users/{userId}/login-token返回一个仅可使用一次的令牌（有效期60秒），该令牌与用户、环境和组织绑定，并附带一个url。请将用户的浏览器重定向到该URL，用户即可使用自己的会话进入ProcessMind：无需邮件链接，也不会进行身份冒用。您还可以在请求正文中传入path，以深度链接到特定页面。密钥必须具有sessions权限范围，并且只能为该密钥获准服务的租户生成用户令牌。

令牌生成操作会被审计，并受到严格的速率限制；密钥被禁用或用户失去访问权限后，操作会立即被阻止。令牌只返回一次，且不会写入日志。

相关主题

• API概览：如何发起API调用。
• API参考：端点文档。