巡护任务API

  • 请求方法为 POST。
  • 数据提交方式 application/json。
  • 支持https调用。
  • 支持微信/支付宝小程序、App、Web端等调用。
请求参数
名称 类型 是否必须 描述
app_key String TOP分配给应用的AppKey。
session String 用户登录授权成功后,TOP颁发给当前用户的授权信息,API提示需要授权信息时,必传。
timestamp String 时间戳,格式为yyyy-MM-dd HH:mm:ss,时区为GMT+8,例如:2015-01-01 12:00:00。API服务端允许客户端请求最大时间误差为前后各3分钟。
sign String API输入参数签名结果(仅支持md5加密)
  • 对所有API请求参数(包括公共参数和业务参数,但除去sign参数、非必填项值为空的参数、byte[]类型的参数,byte[]使用base64编码后,也无需加入签名),根据参数名称的ASCII码表的顺序排序。如:foo:1, bar:2, foo_bar:3, foobar:4排序后的顺序是bar:2, foo:1, foo_bar:3, foobar:4。
  • 将排序好的参数名和参数值拼装在一起,根据上面的示例得到的结果为:bar2foo1foo_bar3foobar4
  • 把拼装好的字符串采用utf-8编码,使用签名算法对编码后的字节流进行摘要。如果使用MD5算法,则需要在拼装的字符串前加上app的secret后,再进行摘要,如:md5(secret+bar2foo1foo_bar3foobar4)。
响应参数
名称 类型 描述
is_error Boolen 是否出错
error_code String 错误码
error_msg String 错误信息
msg String 业务信息

接口地址:http://api-for.reelmall.cn/v1/prjob/get

接口说明:

请求参数:
名称 类型 必须 示例值 描述
prjob_id Number true 任务id
user_id Number true 用户id

响应参数:
名称 类型 示例值 描述
prjob PrJob 任务信息

接口地址:http://api-for.reelmall.cn/v1/prjob/getlist

接口说明:

请求参数:
名称 类型 必须 示例值 描述
user_id Number true 用户id
prjob_type_s String false 任务类型,默认全部,多个类型,可传入逗号隔开组合值,1:临时任务,3:日常任务
page_size Number false 每页行数,默认20
page_no Number false 第几页,默认1
end_created DateTime false 任务创建截至,默认当天,格式:1970-01-01 00:00:00
start_created DateTime false 任务创建时间,默认60天前,格式:1970-01-01 00:00:00

响应参数:
名称 类型 示例值 描述
prjobs PrJob[] 任务集合
total_results Number 总行数
total_pages Number 总页数

接口地址:http://api-for.reelmall.cn/v1/prjob/start需要授权信息

接口说明:

请求参数:
名称 类型 必须 示例值 描述
prtask_id String true 巡护进度id

响应参数:
名称 类型 示例值 描述
prtaskitem_id Number 巡护进度子数据id
is_previous Boolean 是否继续上一次的任务
curr_num Number 当前是第几次巡护
start_time String 任务开始时间

接口地址:http://api-for.reelmall.cn/v1/prjob/stop需要授权信息

接口说明:

请求参数:
名称 类型 必须 示例值 描述
prtaskitem_id Number true 巡护进度子数据id

响应参数:
名称 类型 示例值 描述

接口地址:http://api-for.reelmall.cn/v1/prjob/complete需要授权信息

接口说明:

请求参数:
名称 类型 必须 示例值 描述
prtaskitem_id Number true 巡护进度子数据id
longitude String true 定位经度
latitude String true 定位纬度
desc String false 描述,无则不传
image_id Number true 拍照图片id
image_url String true 拍照图片url
audio_id Number false 音频文件id,无则不传
audio_url String false 音频文件url,无则不传
end_time DateTime true 2000-01-01 00:00:00 完成时间,格式为 yyyy-MM-dd HH:mm:ss

响应参数:
名称 类型 示例值 描述

接口地址:http://api-for.reelmall.cn/v1/prjob/gettrail

接口说明:

请求参数:
名称 类型 必须 示例值 描述
prtaskitem_id Number false 巡护进度子数据id
prtask_id Number false 巡护进度id,prtaskitem_id为空时,必输,否则不传入
curr_num Number false 当前次数,prtaskitem_id为空时,必输,从1开始

响应参数:
名称 类型 示例值 描述
prtrails PrTrail[] 巡护足迹集合