术语解释

本章节将帮助您快速了解API相关术语

Client Id

• 中文名称：企业应用ID

• 详细描述：

  • 企业应用调用接口的基本单元。

  • 要使用 CyberMedia API，需要先申请企业应用。联系对接的业务同学询问申请流程。然后提交申请，等待审核，审核通过后，您将获取应用ID（client_id）和密钥（secret）。

  • 使用应用ID和对应的密钥请求应用令牌接口，就可以获取应用令牌了。

  • 每个企业最多允许创建2个应用，我们会按您的实际需求进行审核，请确保应用描述详细和准确。

Secret

• 中文名称：应用密钥

• 详细描述：

  • 每一个企业应用（APPID）都对应唯一的密钥，当企业应用通过审核后会同时获得的应用ID和密钥。

  • secret用于获取应用令牌。

Access Token

• 中文名称：应用令牌

• 详细描述：

  • Access Token是调用API接口的调用凭证，用于服务端对API请求鉴权，默认有效期为永久。可以通过应用令牌接口获取。

  • 一旦重置应用密钥（secret），当前正在使用的应用令牌将立即过期并无法访问CyberMedia API，可以通过应用令牌接口获取新的应用令牌。

Event CallBack Url

• 中文名称：事件回调地址

• 详细描述：

  • 事件回调地址是用POST请求的方式来通知企业对应事件的进度和完成状态。

Header Key

• 中文名称：请求头键

• 详细描述：

  • 用来实现事件回调地址请求的基本认证。

Header Value

• 中文名称：请求头值

• 详细描述：

  • 用来实现事件回调地址请求的基本认证。

  • CyberMedia API 对应的事件进度更新后会触发事件回调，回调的方式是以POST请求来调用事件回调信息中配置的事件回调地址，此时请求头键和请求头值会以键值对的形式添加在本次请求的请求头中作为认证标识。