API接入指南
引言
平台功能
支持设备范围
接入准备
接入步骤
获取应用接入秘钥(AK/AS)
什么是应用接入秘钥AK/ASAK:AppKey ID 应用接入键标识,用于标识用户身份。一个用户有且仅有一个AK。 AS:AppKey Secret 应用接入键秘钥,是一个用于验证您拥有该 AppKey 的密码。 AK与AS一一对应,用户使用 AK/AS 生成 API 接口鉴权信息。 如何获取AK/AS 首先注册登录“诺瓦云开放平台”。诺瓦 云服务在多个国家和地区独立部署,以确保数据的隔离和安全。为了访问您所在区域的云服务,请选择正确的节点登录。已有屛精灵、屏老板账号的用户可以直接登录。用户登录平台后自动获得AK/AS、API服务域名地址,用户默认拥有基础 API 接口的调用权限。用户通过企业认证后可以获得全部的 API 接口调用权限。 
确认请求地址(URL)
诺瓦云服务根据不同的请求路径区分不同的请求。服务域名可在诺瓦开放平台内获取,具体 API 路径请参考 API 接口文档。请求协议:https 服务域名示例:openapi-us.vnnox.com API请求路径示例:/v2/player/list
结合请求协议、API服务域名、具体 API 请求路径,可以拼接为完整请求地址(URL)。
示例:https://openapi-us.vnnox.com/v2/player/list
结合请求协议、API服务域名、具体 API 请求路径,可以拼接为完整请求地址(URL)。
示例:https://openapi-us.vnnox.com/v2/player/list
准备公共请求参数
为保证 API 的安全调用,诺瓦云服务端会对每个 API 的访问请求进行身份验证。每个 API 需先配置 API 的公共请求参数,包括 :AppKey、Nonce、CurTime 和 CheckSum。公共请求参数需放在请求头(Request Header)中。公共请求参数类型均为字符串。
参数 | 说明 |
---|---|
AppKey | 接入标识。 |
Nonce | 随机字符串(8~64个字符,仅限数字或英文字母) |
CurTime | 当前 UTC 时间戳,从 1970 年 1 月 1 日 0 时 0 分 0 秒开始到现在的秒数。为确保请求的真实性与及时性,客户端与服务端之间的时间戳误差应控制在5分钟以内。超过最大误差视为无效请求。 |
CheckSum | 基于 AK/AS 生成请求签名,详见步骤四。CheckSum = SHA256(AppSecret + Nonce + CurTime) |
生成请求签名(CheckSum)
CheckSum 可通过将获取的 AppSecret 结合 Nonce 和 CurTime 这两个参数拼接成字符串,然后再进行 SHA256 哈希计算来生成。
计算生成 CheckSum 后,把值填入上一步的公共请求头中。诺瓦服务端在接收到 API 请求后,也会采用同样的方法进行 CheckSum 的计算与校验。
CheckSum = SHA256(AppSecret + Nonce + CurTime)
计算生成 CheckSum 后,把值填入上一步的公共请求头中。诺瓦服务端在接收到 API 请求后,也会采用同样的方法进行 CheckSum 的计算与校验。
组装具体 API 接口请求参数
配置完公共请求参数后,您需继续配置相关 API 的具体业务参数。GET接口:业务参数以 POST接口:业务参数以
Content-Type: application/x-www-form-urlencoded
方式在 URL 路径中传递Content-type: application/json; charset=utf-8
方式在请求 Body 体内传递应用发起请求
请求示例:公共请求头参数准备请求示例:cURL模拟发送请求 请求成功示例 请求失败示例
限流说明
业务流程示例
修改于 2024-07-26 08:38:24