摇一摇周边开发者接口文档
目录
1 申请设备ID
2 编辑设备信息
3 配置设备与门店的关联关系
4 查询设备列表
1,申请设备ID接口说明 申请配置设备所需的UUID、Major、Minor。申请成功后返回批次ID,可用返回的批次ID用“查询设备列表”接口拉取本次申请的设备ID。单次新增设备超过500个,需走人工审核流程,大概需要三个工作日;单次新增设备不超过500个的,当日可返回申请的设备ID。一个公众账号最多可申请99999个设备ID,如需申请的设备ID数超过最大限额,请邮件至zhoubian@tencent.com,邮件格式如下: 标题:申请提升设备ID额度 内容:1、公众账号名称及appid(wx开头的字符串,在mp平台可查看) 2、用途 3、预估需要多少设备ID
接口调用说明http请求方式: POST(请使用https协议)https://api.weixin.qq.com/shakearound/device/applyid?access_token=ACCESS_TOKENPOST数据格式:jsonPOST数据例子:{ "quantity":3, "apply_reason":"测试", "comment":"测试专用", "poi_id":1234 }
参数说明
参数是否必须说明
access_token是调用接口凭证
quantity是申请的设备ID的数量,单次新增设备超过500个,需走人工审核流程
apply_reason是申请理由,不超过100个字
comment否备注,不超过15个汉字或30个英文字母
poi_id否设备关联的门店ID,关联门店后,在门店1KM的范围内有优先摇出信息的机会。门店相关信息具体可查看门店相关的接口文档
返回说明 正常时的返回JSON数据包示例:当申请个数小于等于500时,{"data": { "apply_id": 123, "device_identifiers":[ { "device_id":10100, "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825", "major":10001, "minor":10002 } ] }, "errcode": 0, "errmsg": "success."}当申请个数大于500时,{"data": { "apply_id": 123, "audit_status": 0, "audit_comment": "审核未通过" }, "errcode": 0, "errmsg": "success."}
参数说明
参数说明
device_identifiers指定的设备ID列表
device_id设备编号
UUID、major、minorUUID、major、minor
audit_status审核状态。0:审核未通过、1:审核中、2:审核已通过;审核会在三个工作日内完成
audit_comment审核备注,包括审核不通过的原因
apply_id申请的批次ID,可用在“查询设备列表”接口按批次查询本次申请成功的设备ID。
2,编辑设备信息接口说明 编辑设备的备注信息。可用设备ID或完整的UUID、Major、Minor指定设备,二者选其一。接口调用说明http请求方式: POST(请使用https协议)https://api.weixin.qq.com/shakearound/device/update?access_token=ACCESS_TOKENPOST数据格式:jsonPOST数据例子:{ "device_identifier":{ "device_id":10011, "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825", "major":1002, "minor":1223 }, "comment": “test”}
参数说明
参数是否必须说明
access_token是调用接口凭证
device_identifier是指定的设备ID
device_id是设备编号,若填了UUID、major、minor,则可不填设备编号,若二者都填,则以设备编号为优先
UUID、major、minor是UUID、major、minor,三个信息需填写完整,若填了设备编号,则可不填此信息。
comment是设备的备注信息,不超过15个汉字或30个英文字母。
返回说明 正常时的返回JSON数据包示例:{ "data": { }, "errcode": 0, "errmsg": "success."}
3,配置设备与门店的关联关系接口说明 修改设备关联的门店ID、设备的备注信息。可用设备ID或完整的UUID、Major、Minor指定设备,二者选其一。接口调用说明http请求方式: POST(请使用https协议)https://api.weixin.qq.com/shakearound/device/bindlocation?access_token=ACCESS_TOKENPOST数据格式:jsonPOST数据例子:{ "device_identifier":{ "device_id":10011, "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825", "major":1002, "minor":1223 }, "poi_id": 1231, }
参数说明
参数是否必须说明
access_token是调用接口凭证
device_identifier是指定的设备ID
device_id是设备编号,若填了UUID、major、minor,则可不填设备编号,若二者都填,则以设备编号为优先
UUID、major、minor是UUID、major、minor,三个信息需填写完整,若填了设备编号,则可不填此信息。
poi_id是Poi_id 的说明改为:设备关联的门店ID,关联门店后,在门店1KM的范围内有优先摇出信息的机会。门店相关信息具体可查看门店相关的接口文档
返回说明 正常时的返回JSON数据包示例:{ "data": { }, "errcode": 0, "errmsg": "success."}
4,查询设备列表接口说明 查询已有的设备ID、UUID、Major、Minor、激活状态、备注信息、关联门店、关联页面等信息。可指定设备ID或完整的UUID、Major、Minor查询,也可批量拉取设备信息列表。接口调用说明http请求方式: POST(请使用https协议)https://api.weixin.qq.com/shakearound/device/search?access_token=ACCESS_TOKENPOST数据格式:jsonPOST数据例子:查询指定设备时:{ "device_identifiers":[ { "device_id":10100, "uuid":"FDA50693-A4E2-4FB1-AFCF-C6EB07647825", "major":10001, "minor":10002 } ]}需要分页查询或者指定范围内的设备时:{ "begin": 0, "count": 3}当需要根据批次ID查询时:{ "apply_id": 1231, "begin": 0, "count": 3}
参数说明
参数是否必须说明
access_token是调用接口凭证
device_identifier是指定的设备ID
device_id是设备编号,若填了UUID、major、minor,则可不填设备编号,若二者都填,则以设备编号为优先
UUID、major、minor是UUID、major、minor,三个信息需填写完整,若填了设备编号,则可不填此信息。
apply_id是批次ID,申请设备ID时所返回的批次ID
begin是设备列表的起始索引值
count
页:
[1]