Packages
wechat_sdk
0.1.3
0.19.0
0.18.1
0.18.0
0.16.1
0.16.0
0.15.3
0.15.2
0.15.1
0.15.0
0.14.7
0.14.6
0.14.5
0.14.4
0.14.3
0.14.2
0.14.1
0.14.0
0.13.9
0.13.8
0.13.7
0.13.6
0.13.5
0.13.4
0.13.3
0.13.2
0.13.1
0.13.0
0.12.8
0.12.7
0.12.6
0.12.5
0.12.4
0.12.3
0.12.2
0.12.1
0.12.0
0.11.1
0.11.0
0.10.4
0.10.3
0.10.2
0.10.1
0.10.0
0.9.1
0.9.0
0.8.0
0.7.2
0.7.1
0.7.0
0.6.6
0.6.5
0.6.4
0.6.3
0.6.2
0.6.1
0.6.0
0.5.0
0.4.1
0.4.0
0.3.0
0.2.2
0.2.1
0.2.0
0.1.3
0.1.2
0.1.1
0.1.0
WeChat SDK for Elixir, 支持: 公众号/小程序/第三方应用/企业微信/微信支付
Current section
Files
Jump to
Current section
Files
wechat_sdk
README.md
README.md
# WeChat
**WeChat SDK for Elixir**
目前 `Elixir` 中支持最完善的微信SDK。
## Installation
You can use wechat in your projects by adding it to your `mix.exs` dependencies:
```elixir
def deps do
[
{:wechat, "~> 0.1.0", hex: :wechat_sdk}
]
end
```
[在线文档](http://hexdocs.pm/wechat_sdk/).
## Usage
### 定义 `Client` 模块
#### 公众号(默认):
```elixir
defmodule YourApp.WeChatAppCodeName do
@moduledoc "CodeName"
use WeChat,
appid: "wx-appid",
appsecret: "appsecret"
end
```
#### 小程序:
```elixir
defmodule YourApp.WeChatAppCodeName do
@moduledoc "CodeName"
use WeChat,
app_type: :mini_program,
appid: "wx-appid",
appsecret: "appsecret"
end
```
#### 第三方应用:
```elixir
defmodule YourApp.WeChatAppCodeName do
@moduledoc "CodeName"
use WeChat,
by_component?: true,
app_type: :official_account | :mini_program, # 默认为 :official_account
appid: "wx-appid",
component_appid: "wx-third-appid", # 第三方 appid
end
```
### 调用接口
同时支持两种方式调用
```elixir
YourApp.WeChatAppCodeName.Material.batch_get_material(:image, 2)
# or
WeChat.Material.batch_get_material(YourApp.WeChatAppCodeName, :image, 2)
```
更多详情请见：[WeChat模块](https://hexdocs.pm/wechat_sdk/WeChat.html)
### 支持接口列表
[微信官方文档](https://developers.weixin.qq.com/doc/offiaccount/Getting_Started/Overview.html)
* 消息管理
* 素材管理
* 图文消息留言管理
* 自定义菜单
* 用户管理
* 账号管理
* 微信卡券(WIP)
* 第三方平台
* 小程序(WIP)
更多接口正在开发中……
## 快速测试
微信提供申请测试号，用于快速测试
- [申请公众号测试号](https://developers.weixin.qq.com/doc/offiaccount/Basic_Information/Requesting_an_API_Test_Account.html)
- [申请小程序测试号](https://developers.weixin.qq.com/miniprogram/dev/devtools/sandbox.html)
## Contributing
如果有接口未覆盖到，欢迎提交 `PR`，感谢。
## License
wechat source code is released under Apache 2 License. Check the [LICENSE](./LICENSE) file for more information.