go wx gateway
1.0.0
go-wx-gateway est un service de passerelle de compte public WeChat mis en œuvre sur la base de go-wx-api.go-wx-gateway est un programme de proxy inverse pour l'interface API de la plateforme de compte officiel WeChat.go-wx-gateway ne transfère pas simplement les données liées à l'API du compte public WeChat, mais décompresse et conditionne les paquets qu'il envoie et reçoit, de sorte que l'activité derrière le proxy inverse go-wx-gateway puisse être grandement simplifiée.go-wx-gateway exécuté, il communique avec le service métier back-end via http, et tout langage prenant en charge le service http peut implémenter le code métier. 
go-wx-gateway , le développement des services de compte public WeChat est le développement de services Web ordinaires.go-wx-gatewaygo-wx-gateway go-wx-gateway prendre en charge et transmettre les informations utilisateur et la valeur de l'état du menu au service de traitement du menu.go-wx-gateway gère l'autorisation de la page Web, le compte officiel peut également pointer vers le service dont vous avez besoin, puis transférer le code obtenu go-wx-gateway en échange de l'accès à l'openId de l'utilisateur pour obtenir un code complet. informations utilisateur. Pour cette méthode, reportez-vous aux informations de configuration « sns-auth2 ».go-wx-gateway et le code métier, et le format des données est JSON. Prérequis : aller à 1.11.x et supérieur, git, make ont été installés
Entrez n’importe quel dossier et exécutez la commande
$ git clone https://github.com/rosbit/go-wx-gateway
$ cd go-wx-gateway
$ make Si la compilation réussit, le programme exécutable de wx-gateway sera obtenu. Vous pouvez exécuter ./wx-gateway -v pour afficher les informations sur le programme.
La version binaire de Linux peut être téléchargée directement à partir des versions.
est un JSON
Exemple, peut être modifié via 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 Si msg-proxy-pass n'est pas configuré, wx-gateway peut être utilisé comme un outil pour activer开发/服务器配置et peut implémenter des réponses d'écho via des zones de texte pour les utilisateurs qui suivent des comptes publics. développement.
Communication avec msg-proxy-pass
msg-porxy-pass est configuré avec un préfixe d'adresse URL, wx-gateway ajoutera le message et le type d'événement à la fin pour former une URL complète. Par exemple:msg-proxy-pass est configuré sur http://wx.myhost.com/msghandlerwx-gateway reçoit le message texte de l'utilisateur, il transmet le message à http://wx.myhost.com/msghandler/msg/textwx-gateway reçoit un événement d'attention d'un nouvel utilisateur, il transmet le message à http://wx.myhost.com/msghandler/event/subscribemsg et event sont des types de transfert, text et subscribe sont des noms de message ou d'événement spécifiques. Tous les noms correspondent aux messages correspondant à la plateforme publique WeChat.POST et tous les résultats de requête/réponse sont JSON Le JSON du corps de la requête est converti à partir du format XML du message de l'API du compte officiel WeChat. Pour des champs spécifiques, vous pouvez toujours vous référer à l'API du compte officiel WeChat.msg incluent le texte , l'image , la voix , la vidéo , la vidéo courte , l'emplacement , le lien.event incluent CLICK , VIEW , SCAN , Subscribe , Unsubscribe , Location , LOCATION , pic_sysphoto , pic_photo_or_album , pic_weixin , scancode_waitmsg , scancode_push , MASSSENDJOBFINISH , TEMPLATESENDJOBFINISHmsg , text du nomURL : <msg-proxy-pass>/msg/text
Corps du message de la demande :
{
"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发生错误，则有错误信息，否则该值为空"
}réponse
En cas de succès, il doit s'agir d'une réponse de 200 messages, au format du corps du message.
{
"type" : " text " ,
"msg" : "需要返回给用户的消息内容"
}"type" peut être "voix", "vidéo", "image", etc., et "msg" est leur "mediaId" correspondant
event , nom subscribeCorps du message de la demande :
{
"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发生错误，则有错误信息，否则该值为空"
}réponse
identique au message
En cas de succès, il doit s'agir d'une réponse de 200 messages, au format du corps du message.
{
"type" : " text " ,
"msg" : "需要返回给用户的消息内容"
}"type" peut être "voix", "vidéo", "image", etc., et "msg" est leur "mediaId" correspondant
event de magasin de vidéos, channels_ec_order_payCorps du message de la demande :
{
"ToUserName" : "视频号小店的id " ,
"FromUserName" : "在视频号小店购物的用户的openId " ,
"CreateTime" : 1556088649 ,
"MsgType" : " event " ,
"Event" : " channels_ec_order_pay " ,
"order_info" : {
"order_id" : 3705115058471208928 , // NOTE: 文档处是字符串，实际返回的整数
"pay_time" : 1658509200
}
}réponse
Communication avec redirect-url
Gérer les demandes d'autorisation de pages Web. Pour la configuration pertinente du compte public, veuillez vous référer à la documentation WeChat. L'URL de rappel n'a besoin que du nom de domaine où se trouve wx-gateway
redirect-url configure une URL, telle que
redirect-url est http://wx.myhost.com/menu/path/to/redirectwx-gateway reçoit une demande de page Web, il transmet le message à l'URL ci-dessusPOST . Le résultat de la réponse est entièrement déterminé par le service de traitement de transfert. Son résultat de réponse HTTP sera reflété dans le navigateur du compte public. Pour que wx-gateway reçoive les événements de clic de menu, l'URL doit être écrite dans le format autorisé par la page Web du compte officiel :
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_redirectwx-gateway est correctement configuré qu'il peut recevoir les événements de menu, obtenir l'openId de l'utilisateur qui a cliqué sur le menu via le code et le transmettre à redirect-url Format de message de demande pour demander 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时的错误信息，如果为空表示没有错误"
} Tous les en-têtes de requête HTTP et les cookies seront transmis à redirect-url , qui pourra être traité en fonction des besoins
Format du message de résultat de la réponse
redirect-url , y compris
