Sha256: de9e863ac083c21d522c27d0f2b2ac5e5e27dab9949492e1ab859f1e61b2685c

Contents?: true

Size: 1.74 KB

Versions: 2

Compression:

Stored size: 1.74 KB

Contents

# wechat-api

https://github.com/lazing/wechat-api

用于微信 api 调用(非服务端推送信息)的处理。

[![Circle CI](https://circleci.com/gh/lazing/wechat-api.svg?style=svg)](https://circleci.com/gh/lazing/wechat-api)
[![Gem Version](https://badge.fury.io/rb/wechat-api.svg)](http://badge.fury.io/rb/ucpaas)

常见的应用场景如:
* 获取关注用户
* 推送模板信息
* 创建二维码
* 创建短链接

远期计划进一步支持微信支付等。

## 为什么不使用其他 gem

* 很多 gem 基于 rails 或其他 web 框架,单独使用过于笨重
* 不够简单,特别是用于多账号管理的时候
* 微信 api 更新频繁,需要易于使用新功能

## 使用方式

````ruby
gem 'wechat-api'
````

````ruby
require 'wechat-api'

client = Wechat::Api::Client.new 'appid', 'appsecret'

client.get 'user/info', nextopenid: 'xxx'
# 当使用 get 方式时,hash 参数将做个 query params 附在请求后

client.post 'user/info/updateremark', openid;'xxxx', remark: '我是注释'
# 当使用 post 方法时,hash 参数将转换为 json,因此可以支持嵌套的结构
````

## 一些预定义方法

预定义接口方法可以方便使用。

目前支持如下:

````ruby
# 创建固定二维码
client.create_qrcode(scene_str)

# 创建临时二维码
client.create_qrcode_temp(scene_id)

# 发送模板消息
client.send_template(template_id, openid, url, data = {})
````

以上接口返回微信文档定义的 json 数据转换后的ruby的 hash 对象

````ruby
{
  "ticket"=>"gQHc7zoAAAAAAAAAASxodHRwOi8vd2VpeGluLnFxLmNvbS9xL0NVeGttUnJrOGZhSTdyX2RzR1F3AAIEZKcDVgMEAAAAAA==",
  "url"=>"http://weixin.qq.com/q/CUxkmRrk8faI7r_dsGQw"
}
````

## 关于贡献
功能请求,请直接 fork 并创建 Merge Request

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
wechat-api-0.1.3 README.md
wechat-api-0.1.1 README.md