Skip to content

Latest commit

 

History

History
518 lines (432 loc) · 20.2 KB

README.md

File metadata and controls

518 lines (432 loc) · 20.2 KB
Raw

Wechat Shake Around 微信摇周边库

Documentation License

Gem Version Dependency Status

The Wechat Shake Around Library is a code base to call the Wechat Shake Around APIs. 微信摇周边库用于调用微信摇周边API。

Recent Update

Check out the Road Map to find out what's the next. Check out the Change Log to find out what's new.

Installation

Add this line to your application's Gemfile:

gem 'wechat-shake_around'

And then execute:

$ bundle

Or install it yourself as:

$ gem install wechat-shake_around

Usage

Registration 注册开通摇周边

Create Registration 申请开通功能 成功提交申请请求后，工作人员会在三个工作日内完成审核。 若审核不通过，可以重新提交申请请求。 若是审核中，请耐心等待工作人员审核，在审核中状态不能再提交申请请求。 industry_id参考所需资质文件

response = Wechat::ShakeAround::Registration.create(access_token, name, phone_number, email, industry_id, qualification_links, apply_reason)
if response.present? && 0==response['errcode'].to_i
  # Do something more...
else
  # Show response['errmsg']
end

Check Registration Audit Status 查询审核状态

response = Wechat::ShakeAround::Registration.load(access_token)
if response.present? && 0==response['errcode'].to_i
  status        = response['data']
  apply_time    = status['apply_time']    # 提交申请的时间戳
  audit_comment = status['audit_comment'] # 审核备注，包括审核不通过的原因
  audit_status  = status['audit_status']  # 0：审核未通过、1：审核中、2：审核已通过
  audit_time    = status['audit_time']    # 确定审核结果的时间戳；若状态为审核中，则该时间值为0
else
  # Show response['errmsg']
end

Material 上传素材

Upload License 上传许可证素材

response = Wechat::ShakeAround::License.create(access_token, Pathname.new('var/ftp/license.jpg'))
if response.present? && 0==response['errcode'].to_i
  license_link = response['data']['pic_url']
else
  # Show response['errmsg']
end

Upload Icon 上传图标素材

response = Wechat::ShakeAround::Icon.create(access_token, Pathname.new('var/ftp/article-icon.jpg'))
if response.present? && 0==response['errcode'].to_i
  icon_link = response['data']['pic_url']
else
  # Show response['errmsg']
end

Handle the Callback of Shaking 处理摇周边行为的回调

Get Beacon & PoI & Page & Shaker 获取摇周边的设备及用户信息

response = Wechat::ShakeAround::Shaking.load access_token, params[:ticket]
if response.present? && 0==response['errcode'].to_i
  page_id = response['page_id']
  open_id = response['openid']
  poi_id  = response['poi_id']
  beacon  = response['beacon_info']
  beacon_distance = beacon['distance']
  beacon_uuid     = beacon['uuid']
  beacon_major    = beacon['major']
  beacon_minor    = beacon['minor']
else
  # Show response['errmsg']
end

Apply the Device IDs 申请Beacon设备ID

Apply Beacon Device IDs 申请设备ID

quantity = 500
reason   = 'Test Purpose'
comment  = 'Some Mall' # optional
poi_id   = nil         # optional Some PoI ID
response = Wechat::ShakeAround::Apply.create access_token, quantity, apply_reason, comment: comment, poi_id: poi_id
# or for short: Wechat::ShakeAround::Apply.create access_token, quantity, apply_reason
if response.present? && 0==response['errcode'].to_i
  apply_id      = response['data']['apply_id']
  audit_status  = response['data']['audit_status']
                  # 0：审核未通过、1：审核中、2：审核已通过
  audit_comment = response['data']['audit_comment']
else
  # Show response['errmsg']
end

Query the Status of Application of Beacon Device IDs 查询设备ID申请审核状态

response = Wechat::ShakeAround::Apply.load access_token, apply_id
if response.present? && 0==response['errcode'].to_i
  apply_time    = response['data']['apply_time']
                  # 提交申请的时间戳
  audit_status  = response['data']['audit_status']
                  # 0：审核未通过、1：审核中、2：审核已通过
  audit_comment = response['data']['audit_comment']
  audit_time    = response['data']['audit_time']
                  # 确定审核结果的时间戳，若状态为审核中，则该时间值为0
else
  # Show response['errmsg']
end

Manage the Beacon Devices 管理Beacon设备信息

Get Beacon information by Batch 查询设备列表

offset   = 40
limit    = 20
apply_id = nil
response = Wechat::ShakeAround::Beacon.index access_token, offset, limit, apply_id
if response.present? && 0==response['errcode'].to_i
  total_count = response['data']['total_count']
  response['data']['devices'].each do |device|
    device_id        = device['device_id']
    uuid             = device['uuid']
    major            = device['major']
    minor            = device['minor']
    status           = device['status']
                       # 0：未激活，1：已激活
    last_active_time = device['last_active_time']
                       # 设备最近一次被摇到的日期（最早只能获取前一天的数据）；新申请的设备该字段值为0
    poi_id           = device['poi_id']
                       # 设备关联的门店ID，关联门店后，在门店1KM的范围内有优先摇出信息的机会
  end
else
  # Show response['errmsg']
end

Get Beacon information 查询设备 device_id 是整数或者Hash结构：{ uuid: UUID, major: MAJOR, minor: MINOR }。

response  = Wechat::ShakeAround::Beacon.load access_token, device_id
if response.present? && 0==response['errcode'].to_i
  total_count = response['data']['total_count']
  response['data']['devices'].each do |device|
    device_id        = device['device_id']
    uuid             = device['uuid']
    major            = device['major']
    minor            = device['minor']
    status           = device['status']
                       # 0：未激活，1：已激活
    last_active_time = device['last_active_time']
                       # 设备最近一次被摇到的日期（最早只能获取前一天的数据）；新申请的设备该字段值为0
    poi_id           = device['poi_id']
                       # 设备关联的门店ID，关联门店后，在门店1KM的范围内有优先摇出信息的机会
  end
else
  # Show response['errmsg']
end

Update Beacon information 编辑设备信息 device_id 是整数或者Hash结构：{ uuid: UUID, major: MAJOR, minor: MINOR }。

response  = Wechat::ShakeAround::Beacon.update access_token, device_id, comment
if response.present? && 0==response['errcode'].to_i
  # Do something more...
else
  # Show response['errmsg']
end

Manage the Beacon Device Groups 管理Beacon设备分组

Get Groups by Batch 查询分组列表

response = Wechat::ShakeAround::Group.index access_token, offset, limit
if response.present? && 0==response['errcode'].to_i
  total_count = response['data']['total_count']
  response['data']['groups'].each do |group|
    group_id   = group['group_id']
    group_name = group['group_name']
  end
else
  # Show response['errmsg']
end

Get Group per ID 查询分组详情

response = Wechat::ShakeAround::Group.load access_token, group_id, offset, limit
if response.present? && 0==response['errcode'].to_i
  group_id    = response['data']['group_id']
  group_name  = response['data']['group_name']
  total_count = response['data']['total_count']
  response['data']['devices'].each do |device|
    device_id = device['device_id']
    uuid      = device['uuid']
    major_id  = device['major_id']
    minor_id  = device['minor_id']
    comment   = device['comment']
    poi_id    = device['poi_id']
  end
else
  # Show response['errmsg']
end

Delete Group 删除分组

response = Wechat::ShakeAround::Group.destroy access_token, group_id
if response.present? && 0==response['errcode'].to_i
  # Do something more
else
  # Show response['errmsg']
end

Update Group 编辑分组信息

response = Wechat::ShakeAround::Group.update access_token, group_id, name
if response.present? && 0==response['errcode'].to_i
  # Do something more
else
  # Show response['errmsg']
end

Create Group 新增分组

response = Wechat::ShakeAround::Group.create access_token, name
if response.present? && 0==response['errcode'].to_i
  group_id = response['data']['group_id']
else
  # Show response['errmsg']
end

Manage Beacon Device Group Relations 管理Beacon设备分组关系

Create Device Group Relation 新增设备分组关联

response = Wechat::ShakeAround::DeviceGroupRelation.create access_token, device_id, group_id
if response.present? && 0==response['errcode'].to_i
  # Do something more
else
  # Show response['errmsg']
end

Destroy Device Group Relation 删除设备分组关联

response = Wechat::ShakeAround::DeviceGroupRelation.destroy access_token, device_id, group_id
if response.present? && 0==response['errcode'].to_i
  # Do something more
else
  # Show response['errmsg']
end

Manage Pages 管理页面

Get Pages by Batch 获取页面列表

response = Wechat::ShakeAround::Page.index access_token, offset, limit
if response.present? && 0==response['errcode'].to_i
  total_count = response['data']['total_count']
  response['data']['pages'].each do |page|
    comment     = page['comment']     # 页面的备注信息
    description = page['description'] # 在摇一摇页面展示的副标题
    icon_url    = page['icon_url']    # 在摇一摇页面展示的图片
    page_id     = page['page_id']     # 摇周边页面唯一ID
    page_url    = page['page_url']    # 跳转链接
    title       = page['title']       # 在摇一摇页面展示的主标题
  end
else
  # Show response['errmsg']
end

Get Page per ID 获取页面详情

response = Wechat::ShakeAround::Page.load access_token, page_id
if response.present? && 0==response['errcode'].to_i
  total_count = response['data']['total_count']
  page        = response['data']['pages'][0]
  comment     = page['comment']     # 页面的备注信息
  description = page['description'] # 在摇一摇页面展示的副标题
  icon_url    = page['icon_url']    # 在摇一摇页面展示的图片
  page_id     = page['page_id']     # 摇周边页面唯一ID
  page_url    = page['page_url']    # 跳转链接
  title       = page['title']       # 在摇一摇页面展示的主标题
else
  # Show response['errmsg']
end

Destroy Page per ID 删除页面

response = Wechat::ShakeAround::Page.destroy access_token, page_id
if response.present? && 0==response['errcode'].to_i
  # Do something more
else
  # Show response['errmsg']
end

Update Page per ID 编辑页面信息

response = Wechat::ShakeAround::Page.update access_token, page_id, title, description, comment, page_link, icon_link
if response.present? && 0==response['errcode'].to_i
  # Do something more
else
  # Show response['errmsg']
end

Create Page 新增页面

response = Wechat::ShakeAround::Page.create access_token, title, description, comment, page_link, icon_link
if response.present? && 0==response['errcode'].to_i
  page_id = response['data']['page_id']
else
  # Show response['errmsg']
end

Manage Beacon Device Page Relations 管理Beacon设备页面关系

Destroy Beacon Page Relation 删除Beacon页面关系 device_id 可以是整数或者Hash结构：{ uuid: UUID, major: MAJOR, minor: MINOR }。

response = Wechat::ShakeAround::BeaconPageRelation.destroy access_token, device_id, page_id
if response.present? && 0==response['errcode'].to_i
  # Do something more
else
  # Show response['errmsg']
end

Create Beacon Page Relation 创建Beacon页面关系 device_id 可以是整数或者Hash结构：{ uuid: UUID, major: MAJOR, minor: MINOR }。

response = Wechat::ShakeAround::BeaconPageRelation.create access_token, device_id, page_id
if response.present? && 0==response['errcode'].to_i
  # Do something more
else
  # Show response['errmsg']
end

Manage Beacon PoI Relation 管理Beacon场地关系

Create Beacon PoI Relation 创建Beacon场地关系 device_id 可以是整数或者Hash结构：{ uuid: UUID, major: MAJOR, minor: MINOR }。

response = Wechat::ShakeAround::BeaconPoiRelation.create access_token, device_id, poi_id
if response.present? && 0==response['errcode'].to_i
  # Do something more
else
  # Show response['errmsg']
end

Beacon Device Report Beacon设备报表

Query Beacon Device Stats. Data by Batch 批量查询设备统计数据接口 date是以秒为单位的整数。page_index从1开始。

response = Wechat::ShakeAround::DeviceReport.index access_token, date, page_index
if response.present? && 0==response['errcode'].to_i
  date        = response['date']
  total_count = response['total_count']
  page_index  = response['page_index']
  response['data']['devices'].each do |device|
    device_id = device['device_id']
    major     = device['major']
    minor     = device['minor']
    uuid      = device['uuid']
    shake_pv  = device['shake_pv']
    shake_uv  = device['shake_uv']
    click_pv  = device['click_pv']
    click_uv  = device['click_uv']
  end
else
  # Show response['errmsg']
end

Beacon Device Daily Report Beacon设备每日报表

Query Beacon Device Stats. Data by Date 以设备为维度的数据统计接口 device_id 可以是整数或者Hash结构： { uuid: UUID, major: MAJOR, minor: MINOR }。 date_range 是字符串范围，形式如： 'yyyy-mm-dd'..'yyyy-mm-dd'。

response = Wechat::ShakeAround::DeviceDailyReport.index access_token, device_id, date_range
if response.present? && 0==response['errcode'].to_i
  response['data'].each do |item|
    date      = item['ftime']
    # 当天0点对应的时间戳
    shake_pv  = item['shake_pv']
    shake_uv  = item['shake_uv']
    click_pv  = item['click_pv']
    click_uv  = item['click_uv']
  end
else
  # Show response['errmsg']
end

Page Report 页面报表

Query Page Stats. Data by Batch 批量查询页面统计数据接口 date是以秒为单位的整数。page_index从1开始。

response = Wechat::ShakeAround::PageReport.index access_token, date, page_index
if response.present? && 0==response['errcode'].to_i
  date        = response['date']
  total_count = response['total_count']
  page_index  = response['page_index']
  response['data']['pages'].each do |page|
    page_id  = page['page_id']
    shake_pv = page['shake_pv']
    shake_uv = page['shake_uv']
    click_pv = page['click_pv']
    click_uv = page['click_uv']
  end
else
  # Show response['errmsg']
end

Page Daily Report 页面每日报表

Query Page Stats. Data by Date 以页面为维度的数据统计接口 page_id 是从1开始的整数。 date_range 是字符串范围，形式如： 'yyyy-mm-dd'..'yyyy-mm-dd'。

response = Wechat::ShakeAround::PageDailyReport.index access_token, page_id, date_range
if response.present? && 0==response['errcode'].to_i
  response['data'].each do |item|
    date     = item['ftime']
    # 当天0点对应的时间戳
    shake_pv = item['shake_pv']
    shake_uv = item['shake_uv']
    click_pv = item['click_pv']
    click_uv = item['click_uv']
  end
else
  # Show response['errmsg']
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/topbitdu/wechat-shake_around. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.