背景说明:

兔展的h5活动页支持调用外部事件,从而完成内部的【任务玩法】或者【助力玩法】状态变更。

使用说明:

准备工作

a、需要在兔展工作台开通对应的自建应用

         1、填写当前应用的名称;

         2、选中【事件】的权限;

         3、勾选【事件】中的权限;

         4、点击保存,等待审核;


b、审核通过后,通过对应自建应用的【应用id】、【授权密钥】来进行接口的请求。


编辑器的配置工作:

1、任务回调的准备——打开编辑器,在任务玩法中,配置任务标识;

2、助力回调的准备——打开编辑器,在助力玩法中,配置助力事件名称、接口标识;

接口对接——任务回调接口:

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

接口描述 phone ,openid,unionid,audid 四个参数至少传一个

请求参数

参数名称参数说明请求类型是否必须数据类型schema
X-Token自建应用访问tokenheadertruestring
paramparambodytrueCbTaskDtoCbTaskDto

schema属性说明

CbTaskDto

参数名称参数说明请求类型是否必须数据类型schema
appId作品idbodytruestring
appInstanceId应用实例IDbodyfalseinteger(int64)
audid客户idbodyfalsestring
cnlDeptId传播的部门IDbodyfalsestring
cnlId传播渠道Idbodyfalsestring
nonce6位随机字符串bodytruestring
openIdwx open idbodyfalsestring
orgId企业IDbodyfalsestring
phone手机号bodyfalsestring
taskId任务idbodytruestring
timestampunix时间戳(毫秒)bodytrueinteger(int64)
unionIdwx union idbodyfalsestring
taskSign任务标识bodyfalsestring

响应状态

状态码说明schema
200OKApiResponse«Void»
201Created
401Unauthorized
403Forbidden
404Not Found
100107参数少传了audid,phone,openId,unionId 至少要传一个


接口对接——助力回调接口:

请求方式 POST

consumes ["application/json"]

produces ["*/*"]

接口描述 企业级接口,hearer必须携带X-Token

请求参数

参数名称参数说明请求类型是否必须数据类型schema
X-Token自建应用访问tokenheadertruestring
paramparambodytrueCbHelpDtoCbHelpDto

schema属性说明

CbHelpDto

参数名称参数说明请求类型是否必须数据类型schema
appId作品idbodytruestring
appInstanceId应用实例IDbodyfalseinteger(int64)
audidaudidbodyfalsestring
cnlDeptId传播的部门IDbodyfalsestring
cnlId传播渠道Idbodyfalsestring
identify触发标识bodyfalsestring
nonce6位随机字符串bodytruestring
openIdwx open idbodyfalsestring
orgId企业IDbodyfalsestring
phone手机号bodyfalsestring
saudidsaudidbodyfalsestring
timestampunix时间戳(毫秒)bodytrueinteger(int64)
unionIdwx union idbodyfalsestring

响应状态

状态码说明schema
200OKApiResponse«Void»
201Created
401Unauthorized
403Forbidden
404Not Found