go-wx-gateway
go-wx-api に基づいて実装されたWeChat パブリック アカウント ゲートウェイサービスです。go-wx-gateway
WeChat 公式アカウント プラットフォームの API インターフェイス用のリバース プロキシ プログラムです。go-wx-gateway
WeChat パブリック アカウント API に関連するデータを単に転送するだけでなく、送受信するパケットを解凍してパッケージ化するため、 go-wx-gateway
リバース プロキシの背後にあるビジネスが大幅に簡素化されます。go-wx-gateway
を実行すると、http を介してバックエンド ビジネス サービスと通信し、http サービスをサポートする任意の言語でビジネス コードを実装できます。 go-wx-gateway
を使用すると、WeChat パブリック アカウント サービスの開発は通常の Web サービスの開発と同じになります。go-wx-gateway
に送信できます。go-wx-gateway
go-wx-gateway
それを引き継ぎ、ユーザー情報とメニュー状態の値をメニュー処理サービスに転送することができます。go-wx-gateway
Web ページの認証を処理させたくない場合は、公式アカウントが必要なサービスを指定し、ユーザーの openId にアクセスして完全な認証を取得する代わりに、取得したコードをgo-wx-gateway
転送することもできます。ユーザー情報。この方法については、設定情報「sns-auth2」を参照してください。go-wx-gateway
とビジネス コード間のデータ送信には HTTP が使用され、データ形式は JSON です。 前提条件: go 1.11.x 以降、git、make がインストールされている
任意のフォルダに入ってコマンドを実行
$ git clone https://github.com/rosbit/go-wx-gateway
$ cd go-wx-gateway
$ make
コンパイルが成功すると、 wx-gateway
の実行プログラムが得られます。 ./wx-gateway -v
を実行すると、プログラム情報を表示できます。
Linux のバイナリ バージョンは、リリースから直接ダウンロードできます。
JSONです
例は、 sample.conf.json
を通じて変更できます。
{
"listen-host" : " " ,
"listen-port" : 7080 ,
"services" : [
{
"name" : "一个名字,随便取" ,
"workerNum" : 5 ,
"timeout" : 0 ,
"wx-params" : {
"token" : "开发/服务器配置中的Token " ,
"app-id" : "开发/公众号开发信息中的AppId " ,
"app-secret" : "开发/公众号开发信息中的AppSecret " ,
"aes-key" : "开发/服务器配置中的EncodingAESKey。如果是明文传输,则该串为空或null "
},
"listen-endpoints" : {
"service-path" : " /wx --开发/服务器配置/服务器地址中的路径部分" ,
"redirect-path" : " /redirect --这个是微信网页授权用到的,设置菜单时都用这个路径,可选"
},
"msg-proxy-pass" : " http://yourhost.or.ip.here --这个地址指向消息/事件处理的服务,如果不处理可以为空" ,
"redirect-url" : " http://yourhost.or.ip/path/to/redirect --完全转发http请求,响应将返回微信服务号,可选" ,
"redirect-userinfo-flag" : "如果通过 snsapi_userinfo 获取参数,在redrect-url中加上特殊字符串参数,用于区分,比如 login。如果为空,使用 snsapi_base 方式获取用户参数"
},
{
"name" : "如果有其它的公众号服务,可以参考上面的信息配置" ,
"注意" : " listen-endpoints中的路径 不能 相同" ,
"视频号小店支持" : "如果是视频号小店,加上 " is-channels-ec " : true 配置项,其中的 " msg-proxy-pass " 配置的是接收视频号小店推送的事件"
}
],
"token-cache-dir" : "缓存access的根路径,这是可选的配置" ,
"common-endpoints" : {
"health-check" : " /health --这是可选的配置,用于http健康检查,该路由配置成内部可访问" ,
"wx-qr" : " /qr --这是可选的路由配置,可以配置成内部可访问的,用于生成微信二维码链接" ,
"wx-qr的参数说明" : " s=<服务名,对应services中的name>&t=temp|forever[&sceneid=<场景id>][&e=<t为temp时的有效秒数>] " ,
"wx-user" : " /user --这是可选的路由配置,可以配置成内部可访问的,用于获取用户信息,参数:s=<服务名>&o=<openId> " ,
"sns-auth2" : " /sns-auth2 -- 这是可选的路由配置,如果网页授权由其它服务接收,可以通过网页授权参数code获取用户信息" ,
"sns-auth2参数说明" : " s=<服务名,对应services中的name>&code=<网页授权得到的code>&[scope=userinfo|base|snsapi_userinfo|snsn_api_base] " ,
"short-url" : " /short-url -- 这是可选的路由配置,用于把长url生成短链接。【注】微信已经停止该服务" ,
"short-url参数说明" : "访问方法POST, POST body: s=<服务名,对应services中的name>&u=<url编码的长URL> " ,
"tmpl-msg" : " /tmpl-msg -- 这是可选的路由配置,用于发送模版消息" ,
"tmpl-msg参数说明" : "访问方法POST, POST body是JSON " ,
"tmpl-msg body例子" : { "s" : "服务名,对应services中的name " , "to" : "用户openid " , "tid" : "模版id " , "url" : "可选,跳转url " , "mp" :{ "说明" : "可选的小程序参数" , "appid" : "小程序appid " , "pagepath" : "页面路径" }, "data" :{ "模版数据key" : "数据" , "数据key2" : " ... " }},
"sign-jsapi" : " /sign-jsapi -- 这是可选的路由配置,用于生产jsapi签名" ,
"sign-jsapi参数说明" : "访问方法POST, POST body: s=<service-name-in-conf>&u=<url-calling-jsapi-in-urlencoding>,结果会返回noncestr, timestamp, signature等结果" ,
"channels-ec-order-detail" : " /channles-ec-order-detail -- 可选,用于获取视频号小店订单详情" ,
"channels-ec-order-detail参数说明" : " s=<服务名,对应services中的name>&o=<订单id> " ,
"channels-ec-refund-detail" : " /channels-ec-refund-detail -- 可选,用于获取视频号小店售后单详情" ,
"channels-ec-refund-detail参数说明" : " s=<服务名,对应services中的name>&o=<售后订单id> " ,
},
"dont-append-userinfo" : " true|false, 各种消息事件是否不增加用户信息,缺省是false,表示追加"
}
$ CONF_FILE=./wx-gateway-conf.json ./wx-gateway
msg-proxy-pass
が設定されていない場合、 wx-gateway
开发/服务器配置
有効にするツールとして使用でき、パブリック アカウントをフォローするユーザーに対してテキスト ボックスを介してエコー応答を実装できます。これはパブリック アカウントにとって不可欠なデバッグ ツールです。発達。
msg-proxy-pass
による通信
msg-porxy-pass
URL アドレス プレフィックスで構成されており、 wx-gateway
メッセージとイベント タイプを末尾に追加して完全な URL を形成します。例えば:msg-proxy-pass
はhttp://wx.myhost.com/msghandler
で構成されますwx-gateway
ユーザーのテキスト メッセージを受信すると、メッセージをhttp://wx.myhost.com/msghandler/msg/text
に転送します。wx-gateway
新しいユーザーのアテンション イベントを受信すると、メッセージをhttp://wx.myhost.com/msghandler/event/subscribe
に転送します。msg
とevent
転送タイプであり、 text
とsubscribe
特定のメッセージまたはイベント名であり、すべての名前は WeChat パブリック プラットフォームに対応するメッセージに対応します。POST
であり、すべてのリクエスト/レスポンス結果はJSON
であり、リクエスト本文の JSON は WeChat 公式アカウント API メッセージの XML 形式から変換されており、特定のフィールドについては引き続き WeChat 公式アカウント API を参照できます。msg
メッセージ名には、 text 、 image 、 voice 、 video 、 shortvideo 、 location 、 linkが含まれますevent
イベント名には、 CLICK 、 VIEW 、 SCAN 、 submit 、 unsubscribe 、 location 、 LOCATION 、 pic_sysphoto 、 pic_photo_or_album 、 pic_weixin 、 scancode_waitmsg 、 scancode_push 、 MASSENDJOBFINISH 、 TEMPLATESENDJOBFINISHが含まれます。msg
メッセージのリクエスト/レスポンスの例、名前のtext
URL: <msg-proxy-pass>/msg/text
リクエストメッセージ本文:
{
"ToUserName" : "公众号的id " ,
"FromUserName" : "发送消息的用户的openId " ,
"CreateTime" : 1556088649 ,
"MsgType" : " text " ,
"Content" : "用户发送的文本内容" ,
"MsgId" : " 22277834746191186 " ,
"说明" : "以上为必传信息,如果配置文件中dont-append-userinfo为false,则有下面的信息" ,
"userInfo" : {
"openid" : " " ,
"nickname" : " " ,
"headimgurl" : " " ,
"city" : " " , "province" : " " , "country" : " " ,
"sex" : 1 ,
"language" : " " ,
"等等" : "各种信息"
},
"userInfoError" : "如果取userInfo发生错误,则有错误信息,否则该值为空"
}
応答
成功した場合は、200 メッセージ (メッセージ本文の形式) で応答する必要があります。
{
"type" : " text " ,
"msg" : "需要返回给用户的消息内容"
}
「type」は「voice」、「video」、「image」などで、「msg」はそれらに対応する「mediaId」です。
event
メッセージのリクエスト/レスポンスの例、名前subscribe
リクエストメッセージ本文:
{
"ToUserName" : "公众号的id " ,
"FromUserName" : "关注公众号的用户的openId " ,
"CreateTime" : 1556088649 ,
"MsgType" : " event " ,
"Event" : " subscribe " ,
"EventKey" : " qrscene_场景ID(新关注) 或 场景ID(扫码) " ,
"Ticket" : "如果是二维码扫码,是二维码的票据" ,
"说明" : "以上为必传信息,如果配置文件中dont-append-userinfo为false,则有下面的信息" ,
"userInfo" : {
"openid" : " " ,
"nickname" : " " ,
"headimgurl" : " " ,
"city" : " " , "province" : " " , "country" : " " ,
"sex" : 1 ,
"language" : " " ,
"等等" : "各种信息"
},
"userInfoError" : "如果取userInfo发生错误,则有错误信息,否则该值为空"
}
応答
メッセージと同じ
成功した場合、それは 200 メッセージ返信、メッセージ本文の形式でなければなりません
{
"type" : " text " ,
"msg" : "需要返回给用户的消息内容"
}
「type」は「voice」、「video」、「image」などで、「msg」はそれらに対応する「mediaId」です。
event
メッセージのリクエスト/レスポンスの例、名前channels_ec_order_pay
リクエストメッセージ本文:
{
"ToUserName" : "视频号小店的id " ,
"FromUserName" : "在视频号小店购物的用户的openId " ,
"CreateTime" : 1556088649 ,
"MsgType" : " event " ,
"Event" : " channels_ec_order_pay " ,
"order_info" : {
"order_id" : 3705115058471208928 , // NOTE: 文档处是字符串,实际返回的整数
"pay_time" : 1658509200
}
}
応答
redirect-url
による通信
Web ページの認証リクエストを処理します。公開アカウントの関連構成については、WeChat のドキュメントを参照してください。コールバック URL には、 wx-gateway
が配置されているドメイン名のみが必要です
redirect-url
、次のような URL を構成します。
redirect-url
構成はhttp://wx.myhost.com/menu/path/to/redirect
です。wx-gateway
Web ページリクエストを受信すると、メッセージを上記の URL に転送します。POST
であり、応答結果は転送処理サービスによって完全に決定され、その HTTP 応答結果はパブリック アカウント ブラウザに反映されます。 wx-gateway
メニュー クリック イベントを受信するには、URL が公式アカウント Web ページで許可された形式で記述されている必要があります。
https://open.weixin.qq.com/connect/oauth2/authorize?appid=在这里填公众号的AppId&redirect_uri=http%3A//wx.myhost.com/这是redirect-path配置的值&response_type=code&scope=snsapi_base&state=这个值用于区分菜单项#wechat_redirect
wx-gateway
正しく構成されている場合にのみ、メニュー イベントを受信し、コードを通じてメニューをクリックしたユーザーの openId を取得し、それをredirect-url
redirect-url
リクエストする際のリクエストメッセージフォーマット
{
"requestURI" : "转发请求的URI,这是微信服务器访问gateway的URI,可以根据实际情况做进一步判断" ,
"appId" : "公众号的AppId,如果同时处理多个公众号,可以用来区分来源" ,
"openId" : "点击菜单的用户的openId " ,
"state" : "在菜单配置中的state的值,用于区分菜单项" ,
"userInfo" : {
"subscribe" : 1 ,
"openid" : " " ,
"nickname" : " " ,
"sex" : 1 ,
"language" : " " ,
"province" : " " ,
"city" : " " ,
"country" : " " ,
"headimgurl" : " " ,
"subscribe_time" : 1386160805 ,
},
"userInfoError" : "请求userInfo时的错误信息,如果为空表示没有错误"
}
すべての HTTP リクエスト ヘッダーと Cookie はredirect-url
に転送され、ニーズに応じて処理できます。
応答結果メッセージフォーマット
redirect-url
によって完全に決定されます。