为了: 管理员
创建 API 密钥
为管理面板的 API 创建一个管理密钥,或为门户网站的 API 创建一个中心密钥,将其限制为仅限您的 IP 地址,并复制一次。
在本文中8 个部分
一个API密钥钥匙 在集成模式下创建的秘密令牌,允许您自己的软件使用中心的 API。可以让您的软件(如案例管理系统)与您的中心平台进行协作。管理密钥通过管理员面板的应用程序接口来处理案例和相关人员的信息;而中心平台的密钥则通过门户的应用程序接口来处理案例内部的各项任务。了解这些应用程序接口能做什么吧。
打开钥匙
前往集成 › 密钥页面,然后选择新的选项。
给它起个名字
在描述之下,说明一下将会使用它的方式,比如“案例同步”等。
限制其使用范围。
在来源CIDR之下,请输入您的系统所使用的公共IPv4地址,例如203.0.113.10,或者一个地址范围,如203.0.113.0/24。来自其他地点的请求将被拒绝。由于该集线器仅能识别IPv4地址,因此IPv6地址也是不会被接受的。
如果你还不知道地址,可以将该框留空,这样就可以输入任意地址。在系统首次调用后,最后使用的IP地址会显示相关信息;详情请参阅如何限制或撤销API密钥部分说明。
选择其类型
在领域下方,选择管理用于管理面板的API,或者选择中心平台用于门户的API。这个选择之后是无法更改的。
打开并添加
积极的 表示开始使用该键。保持此状态:每次调用时都会拒绝使用处于非活动状态的键。请选择 新增金钥。此时会显示“键已添加”的提示。
复制密钥
密钥窗口只会显示一次密钥。请选择“复制”按钮复制到剪贴板,并将密钥存储在一个开发者可以轻松访问的地方,比如密码管理器里。然后选择完成。
接下来会发生什么?
这是一组关键功能,且不会过期。开发者会在每次调用时将其发送给您;详情请参阅如何使用密钥进行API请求认证。它充当您中心的虚拟助手虚拟助手 一个自动化的团队成员,负责发布欢迎信息、签到信息和公司动态;其发布的帖子带有虚拟助理徽章。,因此它所展示的内容就代表了虚拟助手的消息。
上次使用和最后使用的IP地址分别显示了该接口最近一次调用的日期和地址。若要关闭或删除此信息,请参见限制或撤销API密钥的权限部分说明。
如果出了什么问题
- "密钥数量已达到上限。” 您的中心可以拥有两种类型的每个密钥。请删除其中一个不再需要的密钥吧。
- 源CIDR地址格式要求为:“地址块必须是有效的,例如:203.0.113.10或203.0.113.0/24。”请检查您的地址是否正确。正确的地址应该由四个从0到255的数字组成,数字之间用点分隔,而地址范围则用斜杠和一个最多包含32个数字的数字来表示。
- 源CIDR地址提示:“请使用IPv4地址或地址范围,例如203.0.113.10。该API只能通过IPv4进行访问。” 您输入的却是IPv6地址。请使用您的系统默认的IPv4地址吧。
- 你丢失了密钥。 无法再次显示该密钥了。请创建一个新的密钥,将系统迁移到新密钥上,然后删除旧的密钥。如果您的中心节点已经拥有两个此类密钥,请先删除旧的密钥;在拥有新密钥之前,系统无法调用旧密钥。