开发前必读
1. 如何获取appKey和secret?
联系雪影平台客服,并告知对接业务需求,确认无误后,发放接口授权。目前平台大部分数据支持API的形式进行获取。如果有额外的需求,也可一并告知客服,由公司安排研发人员进行对接。
2. 获取令牌注意事项
1.开发者获取令牌有频率限制,具体可参照频率限制一览。请勿频繁对令牌接口进行调用,以避免服务器对开发者进行频率限制。 2.获取到令牌后,开发者应进行本地存储,便于后期调用平台其他接口。平台不对appKey和secret的来源进行校验,一旦令牌泄露,造成的后果由开发者自行负责。 3.为防止调用方的业务中断,开发者应在令牌将要过期前重新获取一次令牌,建议本地缓存过期时间设置为7150秒。 4.任意一次调用正确的appKey和secret获取令牌后,即便上一次获取的令牌尚在有效期内,平台也会将其状态重置为过期。换言之,同一appKey和secret只能存在一个有效令牌。
3. 令牌携带
1.开发者请求接口时,必须在请求头中携带令牌,格式为:Bearer {Token} (注意Bearer 与token之间有一个空格)。 2.前端axios范例:
3.C# 范例
//Request.Headers["Authorization"] = "Bearer " +"您的token"
...
...
string token = 'test'
Request.Headers["Authorization"] = $"Bearer {token}"
4. 平台各接口的频率限制一览
序号 | 接口 | 频率 |
---|---|---|
1 | 获取令牌 | 10次/小时 |
5. 全局信息返回
{
"code": 0,
"msg": "ok",
"data": 'object'
}
返回字段 | 值类型 | 说明 |
---|---|---|
code | int | 接口正常调用时返回 0,不为 0 时则意味发生错误 |
msg | string | 调用接口返回的文本消息内容,如code不为0时,返回错误消息 |
data | object | 调用接口返回的数据体,返回的数据结构请参照各个接口说明 |
6. 平台服务地址
测试环境地址:暂未开放
修改于 2024-03-11 12:39:16