为了: 管理员
了解 API 的功能
了解管理密钥和中心密钥各自的权限范围,为什么每个密钥都充当虚拟助手,以及完整的技术清单在哪里。
在本文中2 个部分
该API使得您的软件(如案件管理系统)能够无需人工干预即可与您的中心平台进行协作。这个API需要使用API密钥钥匙 在集成模式下创建的秘密令牌,允许您自己的软件使用中心的 API。来调用,而密钥分为两种类型:一种用于管理后台功能,比如案件和人员的管理;另一种则用于处理案件内部的操作。
工作原理
两个密钥,两个API接口。 每种密钥都会调用自己的地址,然后会显示你的中枢设备的ID,而另一个密钥则会拒绝该请求。
| 钥匙 | 地址 | 它所达到的程度 |
|---|---|---|
| 管理关键事务 | https://prd-api-manage.caseactive.com/v1/<hub id>/ | 案件信息以及涉及的人员情况、他们的访问权限、角色分工、所处阶段、搜索功能,还有用于查看发票的详细信息。数据导入进度为https://prd-api-manage.caseactive.com/v1/integration/<hub id>/。 |
| hub键 | https://prd-api-app.caseactive.com/v1/<hub id>/ | 每个案例中的所有内容:帖子与评论、文件、表格、电子签名、任务、发票、事件记录、注意事项以及该案例的详细信息。 |
管理键能够调用的功能真是多啊。 只有这些功能而已。如果尝试在管理面板API中调用其他功能,将会出现403错误。BotNotAllowedException
- 案例:创建、读取、更新和删除等操作。详见如何使用管理功能来创建和更新案例。
- 案例成员:添加、列出和删除成员。详见如何使用管理键来添加或删除案例成员。
- 人员管理:包括添加、读取以及禁用或重新启用相关人员。详情请参阅使用管理密钥添加和更新用户部分说明。
- 角色与阶段:请阅读带有管理权限的角色设置相关内容。
- 自定义字段:请阅读关于案例和用户字段的页面说明。请参阅如何使用管理密钥创建和更新案例的相关内容。
- 发票:请阅读相关内容。详见使用管理键读取发票章节。
- 搜索。请参阅使用管理键来搜索案例和用户的相关说明。
- 导入。请参阅使用管理键执行导入操作的相关说明。
每一个按键都相当于你的虚拟助手。 作为你的中心点,有一些关键的标志…… 虚拟助手虚拟助手 一个自动化的团队成员,负责发布欢迎信息、签到信息和公司动态;其发布的帖子带有虚拟助理徽章。. 该工具所展示的信息会显示在该虚拟助手的名称和徽章下,而它所进行的修改则会被记录为该虚拟助手的行动。每个案例都关联着一个虚拟助手,因此,一个中心密钥可以访问所有案例。该工具能够执行虚拟助手所赋予的权力,而默认情况下,这些权力也是工作人员可以使用的。对于已关闭的案例,该工具只能进行只读操作。中心密钥无法创建新案例、添加或删除人员、支付账单,也无法处理或回复任何查询。
密钥不会过期。 一个密钥可以一直使用,直到管理员将其禁用或删除。请尽量将每个密钥限制在使用系统的公共IPv4地址上;有关如何限制或撤销API密钥的信息,请参考如何限制或撤销API密钥部分的内容。
技术文档页面。 每个API都提供了对其所有调用的详细技术说明,无需登录即可查看这些说明:
| 管理密钥 | 中心钥匙 | |
|---|---|---|
| 交互式功能(Swagger UI) | https://prd-api-manage.caseactive.com/ | https://prd-api-app.caseactive.com/ |
| 引用/重新记录 | https://prd-api-manage.caseactive.com/redoc | https://prd-api-app.caseactive.com/redoc |
| 开放API文档 | https://prd-api-manage.caseactive.com/openapi.json | https://prd-api-app.caseactive.com/openapi.json |
这些应用程序会列出自己发起的所有通话记录,其中包括许多无法通过管理密钥来查看的呼叫信息。上面的列表显示了管理密钥可以用来查看的信息。若想在交互界面上尝试拨打电话,请选择授权,然后粘贴你的密钥即可。
一个被锁住的毂。 当您的中心节点在支付失败后被锁定时,系统会拒绝提供管理密钥,并返回403错误代码。 ManageBillingInactiveException. 只要门户还是只读状态,枢纽密钥就可以继续生效:如果支付失败且尚未付款,那么枢纽密钥将持续有效14天;或者当订阅被取消时,枢纽密钥依然有效。从那时起,虽然枢纽密钥仍然可以读取数据,但任何修改都会被拒绝,会返回403错误代码。 BillingReadOnlyException, 直到管理员重新启动该订阅服务为止。
何时使用
使用管理密钥可以让您的中心系统与其他系统保持同步:创建案例、添加客户并将客户分配到相应的案例中;当员工离开时取消他们的访问权限;或者从文件中一次性加载多行数据。使用中心系统密钥,您可以通过自己的软件在案例中进行操作,例如当系统中发生某些变化时,可以及时更新案例信息。
如果你想在变化发生的时候就能立刻得知,而不是等待别人来通知你,可以使用Web钩子功能;详情请参阅如何设置Web钩子。要创建密钥,请参考如何获取API密钥。