什么是动态码？

动态码 是资源发布者提供的一个接口，当用户点击“获取资源”时会调用资源发布者的接口来显示资源内容。

这通常是用来发放 账号密码、Key、兑换码 等动态的情况。

接口协议

资源发布者应当遵循以下协议，否者将无法接入立刻享应用中。

请求方法

POST

Content-Type

application/json

限流

如果限制某个用户只能获取一次，或者想要提示：请1小时候再来获取吧。

此时，HTTP 响应码必须是 429，响应体必须是:

{
  "limit": 3600
}

其中，limit 单位是秒，立刻享会自动将他转化为：N小时N分钟N秒。

获取资源

当用户点击“获取资源”时（还未播放视频广告），将会调用资源发布者的接口。

请求体说明

参数	说明
action	固定值: prefetch
userId	获取资源的用户ID，同一个用户始终唯一
resourceId	资源ID
traceId	请求ID
timestamp	请求时间戳，毫秒

响应体说明

参数	说明
id	内容ID，应当保持全局唯一
content	资源内容。可以是文本也可以是HTML

请求示例

{
  "action": "prefetch",
  "userId": "用户ID",
  "resourceId": "资源ID",
  "traceId": "请求ID",
  "timestamp": 1712198048227
}

响应示例

普通文本

{
  "id": "内容ID，要全局唯一",
  "content": "我是普通文本资源"
}

HTML

{
  "id": "内容ID，要全局唯一",
  "content": "<h1>我是标题</h1><p>支持HTML标签</p>"
}

图文

{
  "id": "内容ID，要全局唯一",
  "content": "<img class='w-full' src='https://mmbiz.qpic.cn/mmbiz_jpg/5Kp2YXOop5K4SfZyKOiaLhaUE32uicNjQYNOAUBY4pjBKKSb7BQOYcwOm8N6dnMFZLXRxwQgdT5YYR9xWGhQ5UKQ/640?wx_fmt=webp&amp;from=appmsg'/>"
}

注意

由于调用此接口是在播放视频广告之前，如果获取失败将不会播放视频广告。

使用资源

当用户播放完毕广告会调用此接口。

请求体说明

参数	说明
action	固定值: fetch
id	获取资源时返回的ID
traceId	请求ID
timestamp	请求时间戳，毫秒

响应体说明 无需响应，HTTP 状态码返回 200 即可。

请求示例

{
  "action": "fetch",
  "id": "资源ID",
  "traceId": "请求ID",
  "timestamp": 1712198048227
}

验证

当开发完毕之后，您可以新建一个“动态码”的资源来填入接口地址进行验证。验证是在公网中进行的，您的服务必须公网可访问。