帮助中心集成

为了: 管理员

使用密钥验证 API 请求

将您的密钥作为持有者令牌发送到管理面板的 API 获取管理密钥,或发送到门户网站的 API 获取中心密钥,并将其限制在您的 IP 地址范围内。

在本文中5 个部分

开始之前

本页面介绍了如何将各种类型的API密钥钥匙 在集成模式下创建的秘密令牌,允许您自己的软件使用中心的 API。发送出去,以及如何进行发送操作。同时,也解释了为什么有些密钥会被拒绝接收。

地址

钥匙基地址例子
管理关键事务https://prd-api-manage.caseactive.com/v1/<hub id>/https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
管理关键文件、进口数据https://prd-api-manage.caseactive.com/v1/integration/<hub id>/https://prd-api-manage.caseactive.com/v1/integration/ca-7e6d5c4b3a2f10/imports
hub键https://prd-api-app.caseactive.com/v1/<hub id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases
Hub键,一个案例https://prd-api-app.caseactive.com/v1/<hub id>/<case id>/https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts

您的hub ID是 ca- 共有14个字符。显示结果为: 集线器 ID 在……上 概述 在您的门户网站上,任何案件页面都配有“复制副本”按钮。每个案件都有唯一的识别码。 cc- 共有14个字符,在列表中显示为: 案例ID.

发送密钥

在每次调用的Authorization头部中发送密钥,位于Bearer之后,并加上一个空格:

curl https://prd-api-manage.caseactive.com/v1/ca-7e6d5c4b3a2f10/roles \
  -H "Authorization: Bearer YOUR_API_KEY"
  • 使用Content-Type: application/json发送JSON格式的数据。
  • 密钥不会过期。只要管理员没有将其关闭或删除,密钥就会一直有效。更多信息请参见集成 › 密钥部分。
  • 所有的呼号都重新进行了分配:无需进行任何会话或令牌交换。
  • 日期和时间均以UTC标准表示。

限制其使用范围。

在……之下 来源CIDR, 密钥可以限制为系统的公共IPv4地址,例如: 203.0.113.10, 或者一个范围,比如 203.0.113.0/24. 该API仅支持IPv4连接,因此当您保存带有IPv6地址或地址范围的配置时会被拒绝。来自其他网络的请求也会因违反协议而被退回状态码401。 LoginSourceIpException. 要更改范围,请参见相关说明。 限制或撤销某个API密钥的使用权限.

钥匙被拒绝

每一次的拒绝都会以一个错误实体形式返回,该实体的message名称即为处理API错误和状态代码中所提到的那个名称。

地位message为什么该怎么办
401Unauthorized没有发送任何密钥,或者所发送的内容并非密钥。检查Authorization头部信息
401HostNotFoundException地址中的中心节点ID不存在再次复制 集线器 ID 内容
401HostPurgingException该枢纽点正在被删除中。请你的管理员帮忙吧。
401SessionNotFoundException该关键元素已被删除,或者属于另一个中心节点。使用当前可用的密钥来操作这个中心节点。
401LoginKeyInactiveException电源已关闭请让管理员来开启它吧。
401LoginKeyWrongApiException一个管理密钥已发送到枢纽节点的地址,或者反过来也是一样的。使用该地址来指定钥匙的类型。
401LoginSourceIpException电话来自钥匙无法触及的范围之外。从允许使用的地址拨打电话,或者扩大可拨打的范围。
401LoginSourceCidrException无法读取钥匙保存的范围信息。正确的来源CIDR
403BotNotAllowedException有一个名为“manage key”的键,但它无法使用这个键参见了解该API能做什么
403ManageBillingInactiveException在支付失败之后,您所在中心的管理员面板被锁定了(仅允许使用密钥进行访问)请管理员更新支付方式。
403BillingReadOnlyException你的中心节点的订阅已到期,其门户权限也变为只读状态,因此只有中心节点才能访问该节点,而无法对其进行任何修改。请管理员重新启动该订阅服务。
403CaseClosedException一个中心节点试图切换一个已关闭的案例首先重新打开这个案例吧。
404CaseNotFoundException一个枢纽节点提到了一个不存在的案例,或者该案例并不存在于你的枢纽中。请检查案件编号。
503LoginSessionException该中心太忙了,没有时间去检查那个关键人物。请稍后再试一次。

401错误通常意味着密钥本身被拒绝了,因此同步过程可能会中断,从而提醒相关人员注意问题。其他错误则通常与通话相关。

相关文章

处理 API 错误和状态码阅读错误正文,了解 400、401、403、404、500 和 503 的含义,以及为什么您的密钥无法查看的项目会返回 404。集成了解 API 的功能了解管理密钥和中心密钥各自的权限范围,为什么每个密钥都充当虚拟助手,以及完整的技术清单在哪里。集成限制或撤销 API 密钥将密钥限制为某些 IP 地址,将其关闭或删除,并查看其最后一次使用时间。集成 · 2 min