Skip to content

Everything about Wechaty

NickWang edited this page Dec 28, 2022 · 55 revisions

Wechaty Token 申请及使用文档和常见问题

0.摘要

本文档将包括:Wechaty 的 API 中英文文档、各个项目链接、多个协议的使用说明、Web协议不能使用情况下如何申请其他协议Token等内容。 本文档将定期更新,提问之前请按照目录,筛选阅读,如果其不能解决你的问题,可以在Wechaty Developers' Home 开发者社群提问,或扫描以下二维码直接与 Juzi BOT 进行沟通。 img_v2_46efef98-4651-4708-8717-10d70f7d846g

Juzibot 的工作时间:提供 5 * 10 小时在线服务,周一至周五(国家法定节假日除外),10:00-20:00

1.Token 的功能和申请

1.1.Token 能够做什么?

Token 是 Wechaty 开放源代码项目中,所设计和支持的一种认证技术,可以使用第三方的 Wechaty Puppet Service 服务。Wechaty 社区中,提供 Puppet Service 的第三方,称之为 Wechaty Puppet Service Provider 。句子互动公司是 Wechaty PadPlus, WxWork, Donut 等 Puppet Service 的 Provider,提供对应 Puppet Service 的 Token ,实现开发者可以使用对应的协议服务。

在设置 Token 后,每个 Token 将可以使得一个微信号以 iPad 或 Mac 登录的方式进行登录,避免了既有网页端登录受限的问题。

1.2.Token 与微信号的关系是什么?

每个 Token 可以使得一个微信号登录,如果希望多个号同时登录,需要获取多个 Token 。 但 Token 不与微信号绑定,即可以多个号不同时段轮流使用一个 Token 进行登录。

1.3.免费 Token 和付费 Token 的区别?

免费 Token 与付费 Token 完全相同,仅仅来源方式不同。 免费 Token 基于开源激励计划申请得到,详见下文「2.如何申请免费 Token」;付费 Token 为直接按月支付云服务费用,详见下文「3.如何申请付费 Token」。

2.免费Token:参与开源激励计划

Juzi.BOT 公司为 Wechaty Contributor Program 提供支持,开发者可以通过发布开源项目来加入激励计划。

2.1.流程概述

2.1.1.领取 15 天免费 Token 用于 MVP 版本开发(关键评价指标:是否填写开源激励计划申请表和项目信息)
2.1.2.领取一年免费 Token 并成为 Wechaty Contributor(关键评价指标:是否为 Wechaty社区贡献代码)

2.2.填写开源激励计划申请表和项目信息

为了参与开源激励计划,需要开发者填写表单,扫描以下二维码联系Juzi BOT或等待其主动联系均可。 img_v2_46efef98-4651-4708-8717-10d70f7d846g

直接填写: Juzi.BOT: Wechaty 开源激励计划2.0申请表

2.3.通过审核后领取 15 天试用 Token :成为开源激励计划试用开发者

在收到开源激励计划申请表和 Github 项目信息后,Juzi BOT 将依照开源激励计划申请表中的联系方式主动联系。
在确认开发者愿意将最终成品代码开源同时在Wechaty社区内撰写一篇博客后,将为开发者发放一个有效期 15 天的 Token 。
开源激励计划的 Token 为 WxWork/Donut/Pad 协议,目前主要支持 node.js 的开发,如果想要使用 Java / Python / Go 进行开发,可以申请 Donut Token,其针对多语言进行了优化,但需要进行付费购买。

2.4.提交源代码后领取长期使用 Token :成为 Wechaty Contributor

在提供有效期 15 天的 Token 后,我们期待开发者将 MVP (最小可行化产品)代码在 Github 中开源,并储存在一个 public repo 中。
此外,开发者需要在 README 最显著位置(通常为标题旁)添加:

[![Powered by Wechaty](https://img.shields.io/badge/Powered%20By-Wechaty-green.svg)](https://wechaty.js.org)
[![Wechaty Contributor Program](https://img.shields.io/badge/Wechaty-Contributor%20Program-green.svg)](https://wechaty.js.org/docs/contributor-program)
[![Juzi.BOT Developer Program](https://img.shields.io/badge/Wechaty%Contributor%20Program-Juzi.BOT-orange.svg)](https://github.com/juzibot/Welcome/wiki/Everything-about-Wechaty/)

Powered by Wechaty Wechaty Contributor Program Juzi.BOT Developer Program

在完成了MVP版本的产品后,可以将完整产品博客发布在 Wechaty 社区中。具体而言,通过Pull Requests按照之前开发者的提交格式,发布在Wechaty Blog中即可。
具体细节可见:如何成为 Wechaty Contributor 提交博客之后,将成为 Wechaty 的 contributor,将被社区 PMC 拉入 Wechaty Contributor 群,与 Wechaty 的开发者们进行更深度的交流沟通。 在wechaty(wechaty.js.org)博客审核通过后,每在一个平台(知乎/简书/掘金等)提交一篇博客,Wechaty 社区额外提供3个月有效期 Token,凭博客链接联系JuziBOT申请 Token 时长。

3.付费Token:直接咨询商务购买

支付相关政策信息,请在扫描以下二维码联系 Juzi BOT,进行审核后,直接与 Juzi BOT 进行对接,本文将不做具体说明。 img_v2_46efef98-4651-4708-8717-10d70f7d846g

4.更多常见问题

4.1.如何检测微信号是否支持web版?
  1. 打开官方微信web版:https://wx.qq.com/
  2. 扫码看能否成功登录微信官方web版
  3. 如果可以,则可以通过基于web协议的第三方工具、原生Wechaty登录微信。
  4. 如果不行,则需要按照上文流程申请 Token,使用其他协议登录。
4.2.开发过程中每次调试都要重新扫码登录怎么办?

检查在创建bot时是否指定了name属性。详细示例参考:https://github.com/wechaty/wechaty-puppet-padplus#example

4.3.如果运行padplus发现报错怎么办?
  1. 先检查本地安装的padplus版本,点击查看最新版本,参考以下命令进行更新。
  2. 若仍存在问题,欢迎在 issue 中查找解决办法或提交新的issue。
npm install wechaty  
npm install wechaty-puppet-padplus
4.4.登录地址显示为北京,数据是否经过句子互动服务器?

为了最大程度地服务开发者,句子互动的padplus协议和macpro协议均通过服务器中转数据的方式,模拟iPad和Mac登录进行处理。
数据不可避免地经过句子互动服务器,但句子互动会对数据进行加密处理,尽可能的保证用户数据安全,阻止任何人以任何方式访问用户数据。

5.开发资源

5.1.Wechaty 官网
5.2.API 文档链接

Tips:英文版信息更全

5.3.Wechaty 项目地址
5.4.padplus 项目地址(基于ipad协议)

https://github.com/wechaty/wechaty-puppet-padplus

5.5.donut 项目地址(基于windows协议)

https://github.com/juzibot/donut-tester

5.6.wxwork(企业微信) 项目地址(使用wechaty搭建一个企业微信机器人)

https://github.com/juzibot/wxwork-tester

Clone this wiki locally