Revizto 开发者门户 关注
开发者门户允许账户所有者和账户管理员管理 Revizto API 集成。 您可以为 Revizto API 集成添加和管理 OAuth 应用,激活由 Revizto 管理的预配置应用(例如 Revizto MCP Server),控制哪些集成可供组织账户成员使用,并管理 API 通知邮箱。
开发者门户使用 OAuth 2.0,使用户能够通过标准的 Revizto 登录和批准流程授权第三方集成。
基于访问代码的现有集成目前仍受支持,以保持向后兼容性。 新的集成应使用开发者门户和 OAuth 应用注册。
另请参阅:
必需权限
具有账户所有者或账户管理员账户角色的用户可以在开发者门户查看和管理应用。 您可以在 Revizto Workspace 的“账户信息/管理账户信息”页面查看您的账户角色。 有关更多信息,请参阅账户和许可证角色。
标准用户可以从应用集成查看账户中已激活的应用,但不能添加应用、编辑应用、查看客户端密钥或管理设置。
用户的 Revizto 访问权限适用于该集成,这意味着它只能访问已授权的 Revizto 用户被允许访问的数据。
访问开发者门户
账户所有者和账户管理员可在 Revizto Workspace 的“开发者门户”中管理 OAuth 应用。 在这里,可以添加和管理自定义应用,启用或禁用预配置应用,管理 API 通知邮箱,并查看可用集成。
要访问开发者门户:
- 登录 ws.revizto.com。
- 如果您是多个账户的成员,请确保选择了正确的账户。
-
打开“工具”下拉菜单,然后选择“管理账户信息”。 如果看不到“管理账户信息”,请参阅必需权限。
-
单击“开发者门户”。
标准用户的应用集成
标准用户无权访问开发者门户,但可以在 Revizto Workspace 的“应用集成”中查看其账户的应用。
“应用集成”提供可用内容的概览,包括:
- 活动的自定义应用。
- 活动的预配置应用。
- 应用描述。
虽然标准用户可以在“应用集成”中查看一般应用信息,但信息仅限于账户中可用内容的基本信息。 它不显示其他详细信息或管理功能,包括:
- 非活动应用(自定义或预配置)。
- 应用的客户端 ID。
- 应用的客户端密钥。
- 应用的重定向 URI。
- 应用管理操作。
如果您预期某个应用可用,但在“应用集成”中看不到它,请联系账户所有者或账户管理员。
要访问“应用集成”:
- 登录 ws.revizto.com。
- 如果您是多个账户的成员,请确保选择了正确的账户。
-
打开“工具”下拉菜单,然后选择“账户信息”。
-
单击“应用集成”。
应用类型
在开发者门户中,有两种类型的应用:预配置应用和自定义应用。
预配置应用
预配置应用由 Revizto 或 Revizto 合作伙伴管理,无需由账户所有者或账户管理员添加。 账户所有者和账户管理员无法查看或编辑预配置应用的客户端 ID、客户端密钥或重定向 URI;他们只能激活或停用该应用。 预配置应用默认已停用,必须先激活,账户成员才能使用。
预配置应用包括 Revizto MCP Server,它允许用户将其 Revizto 账户连接到所选的 AI 工具。 要与 AI 助手建立连接,账户所有者或账户管理员必须先在开发者门户中激活 Revizto MCP Server 应用。 有关设置 Revizto MCP 服务器的更多信息,请参阅将 AI 工具连接到 Revizto MCP 服务器。
自定义应用
另一方面,自定义应用是由账户所有者或账户管理员添加到账户中的应用。 自定义应用在开发者门户中进行设置,账户所有者或账户管理员需要管理在 Revizto 与第三方集成之间建立连接所需的组件。
设置自定义应用包括以下组件:重定向 URI、客户端 ID、客户端密钥以及 API 通知邮箱。
重定向 URI
重定向 URI 是在 OAuth 授权被批准或取消后,Revizto 将用户引导至的回调地址。 该地址由第三方集成提供,在集成的文档中可能被称为回调 URL。
第三方集成使用的每个重定向 URI 都必须在开发者门户中注册。 设置自定义应用时,Revizto 将根据以下参数验证重定向 URI:
- 至少有一个重定向 URI。 也支持多个重定向 URI。
- 协议、域和路径完全匹配。
- 字符大小写一致。
- 生产环境的重定向 URI 使用 HTTPS(localhost 除外)。
- 对于非 localhost 的 URI,端口匹配(对于 localhost,不验证端口)。
- 任何尾部斜杠作为 URI 的一部分完全匹配。
- URI 不包含通配符。
- 在 OAuth 授权过程中,第三方集成使用的重定向 URI 与在开发者门户中为该应用注册的某个重定向 URI 完全匹配。
- 同一自定义应用中不存在重复的重定向 URI。
例如:
- https://app.example.com/oauth/revizto/callback
- https://integrations.company.com/revizto/oauth/callback
- http://localhost:3000/oauth/revizto/callback
如果由于重定向 URI 不匹配而导致授权失败,请检查第三方集成的配置以及在开发者门户中的应用中保存的重定向 URI。
客户端 ID 和客户端密钥
添加自定义应用后,Revizto 会创建客户端 ID 和客户端密钥凭据,这些凭据将作为第三方集成的身份凭据。
- 客户端 ID:在开发者门户中可见并可复制。 第三方集成使用它来标识 OAuth 应用。
- 客户端密钥:在添加应用或重新生成客户端密钥后立即显示。 关闭凭据对话框后,将无法再次查看或复制客户端密钥。
获取客户端密钥后,请务必立即将其安全地存储在第三方集成或您公司的密钥管理器中。
如果客户端密钥丢失,可按照重新生成客户端密钥中的步骤重新生成。 重新生成后,先前的客户端密钥会立即失效,您需要将第三方集成更新为使用新的客户端密钥。
API 通知邮箱
自定义应用中的 API 通知邮箱是该应用和您账户的技术联系人。 可以在添加或编辑自定义应用时管理这些电子邮件。
Revizto 会将重要的 API 相关更新发送到这些电子邮件,例如:
- API 更改。
- 弃用通知。
- 重大变更通知。
- 开发者门户和 OAuth 集成更新。
请尽可能使用共享邮箱,这样无论人员如何变动,您的组织都能持续接收 API 更新。
激活和停用应用
账户所有者和账户管理员可以激活和停用预配置应用和自定义应用。 应用状态适用于整个账户。 标准用户在应用集成中只能看到活动的应用。
当应用被停用后,账户成员将无法使用第三方集成访问 Revizto,所有现有访问以及新的 OAuth 授权尝试都将被阻止。 当应用被重新激活后,用户可能需要使用其 Revizto 用户账户重新登录以重新授权。
要激活或停用应用:
- 导航到 Revizto Workspace 中的开发者门户。
- 找到要激活或停用的应用。
-
在应用的“活动”列中,打开或关闭切换开关(蓝色表示活动)。
-
在确认对话框中,单击“激活”或“停用”以确认继续。
您还可以使用自定义应用的编辑窗格顶部的切换开关来激活或停用该应用,并遵循相同的确认步骤。
激活或停用会立即生效,但账户成员可能需要刷新才能看到更改。
添加自定义应用
自定义应用是添加到组织账户的 OAuth 应用。 自定义应用可用于由您的组织构建、由您的集成团队配置或由需要来自您的 Revizto 账户的 OAuth 凭据的第三方系统设置的集成。
要添加自定义应用:
在添加自定义应用之前,请确认您拥有将要连接到 Revizto 的第三方集成的重定向 URI。
- 导航到 Revizto Workspace 中的开发者门户。
-
单击“+ 添加自定义应用”。
- 在“应用名称”字段中,输入应用的名称。
- 在“重定向 URI”字段中,输入一个或多个重定向 URI。 每个 URI 都必须符合上文“重定向 URI”中描述的参数。
- 如果需要,在“描述”字段中输入应用的描述。
- 在“API 通知联系人”字段中,输入任何应接收来自 Revizto 的 API 相关通信(包括影响您的集成的更改)的用户的电子邮件。
-
单击“添加自定义应用”窗格底部的“添加”。
- 在“应用凭据”窗口中,复制客户端 ID 和客户端密钥。 关闭窗口后,您将无法再次访问该客户端密钥,因此请确保将该信息存储在安全的地方。
-
单击“确定”。
- 将新创建的客户端 ID 和客户端密钥添加到第三方集成中以完成连接。
保存自定义应用后,它将自动激活并保存在“自定义应用”下。
编辑自定义应用
账户所有者和账户管理员可以编辑自定义应用中的名称、描述、重定向 URI 和 API 通知邮箱。 活动和非活动的自定义应用均可编辑。 如果需要获取新的客户端密钥,请参阅重新生成客户端密钥。
要编辑自定义应用:
- 导航到 Revizto Workspace 中的开发者门户。
- 单击要编辑的自定义应用。
-
在应用的编辑窗格中,编辑要更改的字段。
如果更改重定向 URI,还必须更新第三方集成配置,否则,使用原始 URI 的 OAuth 授权尝试将会失败。
- 单击应用的编辑窗格底部的“更新”。
删除自定义应用
账户所有者和账户管理员可以删除自定义应用。 只有非活动的应用才能被删除。 删除应用会将其从账户的可用应用集成中永久移除。
要删除自定义应用:
- 导航到 Revizto Workspace 中的开发者门户。
- 停用要删除的自定义应用。
- 在应用的“操作”列中,单击“删除”
。
- 在“删除应用”窗口中,在确认字段中输入应用名称,确保与窗口中显示的名称完全一致。
-
单击“删除”。
您也可以单击应用的编辑窗格顶部的“删除”
,并遵循相同的确认步骤来删除非活动的自定义应用。
应用将被立即删除,所有现有访问权限都将被撤销。 如果将来想要再次添加相同的第三方集成,则需要添加新的自定义应用。
重新生成客户端密钥
如果自定义应用的客户端密钥丢失、泄露或需要更改,可以重新生成。 重新生成客户端密钥后:
- 先前的客户端密钥会立即失效。
- 新的客户端密钥只显示一次。
- 第三方集成必须更新为使用新的客户端密钥才能继续工作。
要重新生成客户端密钥:
- 导航到 Revizto Workspace 中的开发者门户。
- 找到要重新生成客户端密钥的自定义应用。
- 在应用的“操作”列中,单击“查看凭据”
。
-
在“应用凭据”窗口中,单击客户端密钥旁边的“重新生成密钥”。
- 在确认窗口中,再次单击“重新生成密钥”以确认继续。
- 在“应用凭据”窗口中,复制新的客户端密钥。 关闭窗口后,您将无法再次访问该客户端密钥,因此请确保将该信息存储在安全的地方。
-
单击“确定”。
- 将新创建的客户端密钥添加到第三方集成中以重新建立连接。
故障排除
问:我无法添加自定义应用。
答:只有账户所有者和账户管理员可以添加自定义应用。 请让账户所有者或账户管理员更新您的账户角色或为您添加应用。
问:我丢失了某个自定义应用的客户端密钥。
答:可以按照重新生成客户端密钥中的步骤重新生成客户端密钥。 重新生成后,请立即复制新的客户端密钥并保存在安全的地方,同时更新第三方集成。
问:账户成员无法在第三方集成中授权其 Revizto 账户。
答:请确认以下条件:
- 相关应用的状态为活动。
- 第三方集成使用正确的客户端 ID。
- 第三方集成使用当前的客户端密钥。
- 第三方集成中的重定向 URI 与应用的信息中列出的某个重定向 URI 完全匹配。
- 用户拥有 Revizto 账户的访问权限。
问:账户成员以前可以连接到某个应用,但现在不行了。
答:请确认以下条件:
- 该应用的状态仍为活动。
- 该应用未被删除。
- 在未更新第三方集成的情况下,客户端密钥未重新生成。
问:我在可用应用中看不到 Revizto MCP Server 应用。
答:Revizto MCP Server 应用是一个预配置应用,必须为账户激活。 请让账户所有者或账户管理员确认 Revizto MCP 服务器应用已在开发者门户中激活。