帮助中心  /  第三方任务接口

第三方任务接口

接口功能说明

通过该接口方案,可以完成使用自己系统的任务模式,增加活动的参与机会。比如用户系统签到增加抽奖机会等。该方案包含2个活动任务接口调用和1个自有任务库接口,请仔细阅读本文档活动授权时序图,完成接口对接开发。


用户活动分享流程

  • 1. 用户打开h5活动地址,进入活动,如果参与机会已用完,点击参加活动操作会弹出获取更多机会弹框(需活动高级设置先开启API获得额外机会设置)

  • 2. 用户点击相应操作后,跳转到【第三方任务链接页面,并传入用户Id等参数;

  • 3. 用户在第三方任务页面,完成自己的业务任务后,再主动调用人人秀任务接口】增加用户参与次数,通过参数redirect自动重定向跳转回到活动。


图解用户参与活动时序图:

image.png


1.    第三方任务接口

开发说明

  • 该接口由第三方开发者提供给人人秀调用,必须设置该接口地址。

  • 人人秀重定向到[ 第三方任务接口]时,会对每个参数进行urlencode处理。

  • 第三方开发者,接收到参数,必须先将参数urldecode处理,然后计算签名

请求地址                

第三方提供任务接口                

请求方式                

重定向

参数名称                

是否必须                

说明                

app_key                                

人人秀平台分配的AppKey                                

time_stamp                                

1970-01-01开始的时间戳,精确到毫秒                                

sign                                

根据签名算法所得,如何计算签名                                

activity_guid                                

具体互动guid标识如何获取互动guid标识                                  

h5_guid                                

h5标记来自人人秀哪个活动                                

openid                                

用户的ID                                

task_code                                

自有任务编号,配置在任务设置中                                

redirect                                

当前活动页面的地址,第三方任务完成后返回活动时可用跳转                                


 


请求示例

{

    "app_key": "96c84928b1dce057d110ea3b3880fc83",

"time_stamp":"1543999047492",

"sign ":"051BF3517D40AB9D7D6B45EF6E4EB7F9",

"activity_guid""f2f219309b5c1a021fc019b3b557b9f8",

"h5_guid": "123456",

"openid""gb_1543999047492",

"task_code": "task01",

"redirect": "https%3A%2F%2Fnc.rrxiu.cc%2Fh%2Fpages%2Fwsiteh5%2Findex%3FwsiteGuid%3D4rupzi%26v%3D1"

}




2.    人人秀任务接口

开发说明:

  • 该接口由人人秀提供给第三方开发者调用,第三方开发者调用该接口增加用户参与次数

  • 通过参数redirect自动重定向跳回人人秀活动

  • 授权链接调用后就会失效,每次使用都需要调用接口重新生成链接

请求地址                

https://open.rrx.cn/api/v1/activityShare/completeTask                

请求方式                

重定向

参数名称                

是否必须

说明                

app_key                                

人人秀平台分配的AppKey                                

time_stamp                                

1970-01-01开始的时间戳,精确到毫秒                                

sign                                

根据签名算法所得,如何计算签名                                

activity_guid                                

具体互动guid标识如何获取互动guid标识                                  

h5_guid                                

h5标记来自人人秀哪个活动                                

openid                                

用户的ID                                

task_code                                 

自有任务编号,通过上个接口获得(如果传0 则表示直达任务,自动发放奖励)

reward_type                                

选择API奖励时必传,奖励类型:1:参与次数;2:积分;默认为1                                

add_number                                

用户增加的奖励数量,整数类型                                

redirect                        

当前活动地址,用于增加成功后跳转回活动         

如果是系统直达任务,可为空,则可POST请求返回result信息{"result":0,"msg":""}               


 


对接步骤

第一步,计算签名,参照API接口规范及签名算法

第二步,对参数进行urlencode编码处理

第三步,拼接授权链接

    例如:

    https://open.rrx.cn/api/v1/activityShare/completeTask?app_key=testkey&time_stamp=123&sign=testsign&activity_guid=activity_guid&h5_guid=h5_guid&    openid=openid&task_code=task01&reward_type=1&add_number=1&redirect=redirect

第四步,重定向到授权链接

     例如:

    JavaScript重定向

        window.location.href='授权链接';

    java 重定向

        response.sendRedirect(授权链接)


数据注意事项:

  • 1.计算签名时,不要对参数进行urlencode处理

  • 2.拼接授权链接时,需要对参数进行urlencode处理,避免乱码和错码

  • 3.activity_guid、h5_guid、openid、task_code、redirect,可以从人人秀调用第三方分享任务接口时传递的参数列获得

  • 4.注意接口地址区分大小写 例如:https://open.rrx.cn/api/v1/activityShare/completeTask


请求示例

 

var redirectStrUrl= https://open.rrx.cn/api/v1/activityShare/completeTask? app_key=96c84928b1dce057d110ea3b3880fc83

& time_stamp=1543999047492

& sign =051BF3517D40AB9D7D6B45EF6E4EB7F9

& activity_guid= f2f219309b5c1a021fc019b3b557b9f8

& h5_guid =123456

& openid =gb_1543999047492

& task_code =task01

& reward_type =1

& add_number =1

& redirect =urlEncode(redirect)

window.location.href= redirectStrUrl;

 


3.第三方任务库接口

开发说明:

  • 该接口用于在活动中配置自有任务时,自动获取第三方任务库,选择任务后自动获取任务编号

  • 该接口由第三方开发者提供给人人秀调用,设置后可用

  • 开发者接收到参数,必须先将参数urldecode处理,然后计算签名

请求地址                

由第三方平台提供                

请求方式                

POST                

参数名称                

是否必须                

说明                

app_key                

人人秀平台分配的AppKey                

time_stamp                

1970-01-01开始的时间戳,精确到毫秒                

sign                

根据签名算法所得,如何计算签名                

login_id       

登录账号,查询指定账号数据。   查看子账号账号 

空则是主账号,查询主账号数据否则查询子账号对应数据。                

page                

第几页数据                

limit                

每页多少条数据                

返回JSON格式结果                

{"result":0,"msg":"","data":{}}                

参数名称                

说明                

result                

0表示成功,1表示失败                

msg                

表示失败详细描述                

data                

成功时,返回数据                


data参数说明

参数名称                

是否必须                

说明                

total                

数据总笔数                

rows                

数据列表                


rows参数说明

参数名称                

是否必须                

说明                

name                

任务名称                

code                

任务编码标识                


对接步骤

第一步,对接收的参数进行urldecode处理

第二步,计算签名和验证签名

第三步,返回处理结果,返回值必须是json格式


 

请求示例

{

    "app_key""96c84928b1dce057d110ea3b3880fc83",

"time_stamp":"1543999047492",

"sign ":"051BF3517D40AB9D7D6B45EF6E4EB7F9",

"login_id ":"",

"page ":1,

"limit ":20

}

 

 

返回值示例,json格式 Content-type: application/json

{

    "result"0,

"data"{

  "total"1,

"rows" [

{

"name""任务1",

"code""task_001"

}

]

    },

    "msg""ok"

}





相关文档