获取数据接口使用GET方式
涉及修改数据的接口使用POST
全局参数:请求api的时候放在header里,每个api都要传
Content-Type:application/json
platform(平台):ios/android/
brand(设备品牌):huawei/xiaomi/vivo/oppo/meizu/honour/apple
model(设备型号):根据手机型号传
identity(设备码):设备唯一码
token(用户token):积分墙用户标识
timestamp(时间戳):当前时间戳
sign(签名):预留,接口加密使用
广告商标识符(advertiserType):csj/gdt/ks/baidu/huawei
广告位标识(adAlias):ad_splash(开屏广告)/ad_banner(横幅广告)/ad_inter(插屏广告)/ad_reward(激励广告)/ad_info_stream(信息流广告)/
获取手机品牌
GET api/common/getDeviceTypes
响应:
{
"code": 200,
"message": "success",
"data": [
"huawei",
"xiaomi",
"redmi",
"vivo",
"oppo",
"meizu",
"honour",
"apple"
]
}
获取广告商
GET api/common/getAdvertiserTypes
响应:
{
"code": 200,
"message": "success",
"data": [
"csj",
"gdt",
"ks",
"baidu",
"huawei"
]
}
获取SDK初始化参数
GET api/common/getSDKParams?appId=1234567890&appKey=0987654321
参数: appId: 后台创建的应用ID
appKey: 应用ID对应的key
响应:
{
"code": 200,
"message": "success",
"data": [
{
"AdvertiserType": "csj", // 广告商类型
"appId": "5234682", // 广告商开放平台注册的AppId
"appName": "聚合广告" // 广告商开放平台注册的应用名称
},
{
"AdvertiserType": "gdt",
"appId": "5234682",
"appName": "聚合广告"
},
{
"AdvertiserType": "ks",
"appId": "5234682",
"appName": "聚合广告"
}
]
}
获取广告位参数
同时生成一条广告日志
GET: api/ad/getPositionParams?adAlias=ad_splash
参数: adAlias: 广告位标识
响应:
{
"code": 200,
"message": "success",
"data": {
"advertiserType": "csj", // 广告商类型
"adAlias": "ad_splash", // 广告位标识
"positionId": "7781628", // 广告位Id
"logId": 1, // 广告日志Id
"score": 20, // 激励视频分值
}
}
广告流程结果反馈
POST: api/ad/Result
Body参数:{
"logId": 1, // 广告日志Id
"result": 1 // 结果 1请求API成功,2请求API失败,3广告加载成功,4广告加载失败,5广告曝光,6广告已点击,7广告关闭,8激励视频奖励验证
}
响应:
{
"code": 200,
"message": "success"
}
注:激励视频奖励发放以广告平台回调我们聚合平台的结果为准,详情见各广告平台开发文档。
初始化积分墙(绑定用户)
POST: api/integralWall/index
Body参数:{
"userId": 1, // 必传,用户唯一Id
"mobile": "18359728825", // 非必传,手机号
"nickname": "jame", // 非必传,昵称
}
响应:
{
"code": 200,
"message": "success"
"data": {
"token": "qwertyuiop", // 登录鉴权token
"user"{
"id": 1, // 聚合平台用户Id
"userId": 1, // 代理商平台用户唯一Id
"mobile": "18359728825", // 手机号
"nickname": "jame", // 昵称
}
}
}
积获取分墙主页信息
GET: api/integralWall/index?appDownloadCount=4&appAliveCount=4&dailyCount=5&rewardVideoCount=3
参数说明:
appDownloadCount:APP下载至多获取多少个
appAliveCount:APP触活至多获取多少个
dailyCount:日常任务至多获取多少个
rewardVideoCount:激励视频至多获取多少个
响应:
{
"code": 200,
"message": "success"
"data": {
// 签到模块数据
"sign": {
"isSignToday": true, // 今日是否签到
"isSignYesterday": true, // 昨日是否签到
"signDays": 88, // 签到天数
"signDaysContinuous": 12, // 连续签到天数
"detail": [
{
"title": "第一天", //标题
"score": 5, //积分
"isSign": true //是否签到
},
{
"title": "第二天", //标题
"score": 10, //积分
"isSign": false //是否签到
}
]
},
// APP下载任务模块
"appDownload":[
{
"id": 1, // id
"icon": "https://www.baidu.con/icon/1", // 应用图标
"name": "抖音", // 应用名称
"package": "com.douyin.www", // 应用包名
"link": "https://www.baidu.con/icon/1", // 下载链接
"score": 10, //积分
"logId": 1, // 日志Id
},
{
"id": 2,
"icon": "https://www.baidu.con/icon/2", // 应用图标
"name": "UC浏览器", // 应用名称
"package": "com.uc.www", // 应用包名
"link": "https://www.baidu.con/icon/1", // 下载链接
"score": 20, //积分
},
],
// APP触活任务模块
"appAlive": [
{
"id": 2,
"icon": "https://www.baidu.con/icon/1", // 应用图标
"name": "抖音", // 应用名称
"package": "com.douyin.www", // 应用包名
"score": 10, //积分
"logId": 1, // 日志Id
},
],
// 日常任务
"daily": [
{
"id": 1,
"name": "快应用试玩", // 任务名称
"subName": "限时好物领取", // 任务简介
"score": 10, //积分
"btnText": "去领取", // 按钮文本
"link": "https://www.baidu.con/icon/1", // 链接
"logId": 1, // 日志Id
},
{
"id": 2,
"name": "xxx医美", // 任务名称
"subName": "让你三天变成双眼皮", // 任务简介
"score": 20, //积分
"btnText": "去了解", // 按钮文本
"link": "https://www.baidu.con/icon/1", // 链接
},
],
// 激励视频
"rewardVideo": [
{
"id": 1, // id
"advertiserType": "csj", // 广告商类型
"positionId": "7781628", // 广告位Id
"score": 20, // 激励视频分值
"logId": 1, // 日志Id
}
],
}
}
积分墙签到
POST: api/integralWall/sign
响应:
{
"code": 200,
"message": "success"
"data": {
"isSignToday": true, // 今日是否签到
"isSignYesterday": true, // 昨日是否签到
"signDays": 88, // 签到天数
"signDaysContinuous": 12, // 连续签到天数
"detail": [
{
"title": "第一天", //标题
"score": 5, //积分
"isSign": true //是否签到
},
{
"title": "第二天", //标题
"score": 10, //积分
"isSign": false //是否签到
}
]
}
}
任务流程结果反馈
POST: api/integralWall/Result
Body参数:{
"logId": 1, // 日志Id
"type": 1, // 1APP下载,2APP触活,3日常任务,4激励视频
"result": 1 , // 结果 1请求API成功,2请求API失败,3广告加载成功,4广告加载失败,5广告曝光,6广告已点击,7广告关闭,8激励视频奖励验证
}
响应:
{
"code": 200,
"message": "success"
}