go-wx-gateway
é um serviço de gateway de conta pública WeChat implementado com base em go-wx-api.go-wx-gateway
é um programa de proxy reverso para a interface API da plataforma de conta oficial WeChat.go-wx-gateway
não simplesmente transfere os dados relacionados à API da conta pública WeChat, mas descompacta e empacota os pacotes que envia e recebe, para que o negócio por trás do proxy reverso go-wx-gateway
possa ser realizado de forma bastante simplificadago-wx-gateway
, ele se comunica com o serviço comercial de back-end por meio de http, e qualquer linguagem que suporte o serviço http pode implementar o código comercial. go-wx-gateway
, o desenvolvimento de serviços de contas públicas WeChat é o desenvolvimento de serviços web comuns.go-wx-gateway
go-wx-gateway
go-wx-gateway
o controle dele e encaminhe as informações do usuário e o valor do estado do menu para o serviço de processamento de menu.go-wx-gateway
lide com a autorização da página da web, a conta oficial também pode apontar para o serviço que você precisa e, em seguida, transferir o código obtido go-wx-gateway
em troca de acessar o openId do usuário para obter completo informações do usuário. Para este método, consulte as informações de configuração "sns-auth2".go-wx-gateway
e código comercial, e o formato de dados é JSON. Pré-requisito: vá 1.11.xe superior, git, make foram instalados
Entre em qualquer pasta e execute o comando
$ git clone https://github.com/rosbit/go-wx-gateway
$ cd go-wx-gateway
$ make
Se a compilação for bem-sucedida, o programa executável do wx-gateway
será obtido. Você pode executar ./wx-gateway -v
para exibir informações do programa.
A versão binária do Linux pode ser baixada diretamente dos lançamentos.
é um JSON
Exemplo, pode ser modificado através de 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
Se msg-proxy-pass
não estiver configurado, wx-gateway
pode ser usado como uma ferramenta para permitir开发/服务器配置
e pode implementar respostas de eco por meio de caixas de texto para usuários que seguem contas públicas. É uma ferramenta de depuração essencial para contas públicas. desenvolvimento.
Comunicação com msg-proxy-pass
msg-porxy-pass
é configurado com um prefixo de endereço URL wx-gateway
adicionará a mensagem e o tipo de evento ao final para formar um URL completo. por exemplo:msg-proxy-pass
está configurado em http://wx.myhost.com/msghandler
wx-gateway
recebe a mensagem de texto do usuário, ele encaminhará a mensagem para http://wx.myhost.com/msghandler/msg/text
wx-gateway
recebe o evento de atenção de um novo usuário, ele encaminhará a mensagem para http://wx.myhost.com/msghandler/event/subscribe
msg
e event
são tipos de encaminhamento, text
e subscribe
são mensagens específicas ou nomes de eventos. Todos os nomes correspondem às mensagens correspondentes à plataforma pública WeChat.POST
e todos os resultados de solicitação/resposta são JSON
. O JSON do corpo da solicitação é convertido do formato XML da mensagem da API da conta oficial do WeChat. Para campos específicos, você ainda pode consultar a API da conta oficial do WeChat.msg
incluem texto , imagem , voz , vídeo , vídeo curto , localização , linkevent
incluem CLICK , VIEW , SCAN , subscribe , unsubscribe , location , LOCATION , pic_sysphoto , pic_photo_or_album , pic_weixin , scancode_waitmsg , scancode_push , MASSSENDJOBFINISH , TEMPLATESENDJOBFINISHmsg
, text
do nomeurl: <msg-proxy-pass>/msg/texto
Solicitar corpo da mensagem:
{
"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发生错误,则有错误信息,否则该值为空"
}
resposta
Se for bem-sucedido, deverá ser uma resposta de 200 mensagens, formato do corpo da mensagem
{
"type" : " text " ,
"msg" : "需要返回给用户的消息内容"
}
"type" pode ser "voz", "vídeo", "imagem" etc., e "msg" é o "mediaId" correspondente
event
, subscribe
de nomeSolicitar corpo da mensagem:
{
"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发生错误,则有错误信息,否则该值为空"
}
resposta
o mesmo que mensagem
Se for bem-sucedido, deverá ser uma resposta de 200 mensagens, formato do corpo da mensagem
{
"type" : " text " ,
"msg" : "需要返回给用户的消息内容"
}
"type" pode ser "voz", "vídeo", "imagem" etc., e "msg" é o "mediaId" correspondente
event
de locadora de vídeo, nome channels_ec_order_pay
Solicitar corpo da mensagem:
{
"ToUserName" : "视频号小店的id " ,
"FromUserName" : "在视频号小店购物的用户的openId " ,
"CreateTime" : 1556088649 ,
"MsgType" : " event " ,
"Event" : " channels_ec_order_pay " ,
"order_info" : {
"order_id" : 3705115058471208928 , // NOTE: 文档处是字符串,实际返回的整数
"pay_time" : 1658509200
}
}
resposta
Comunicação com redirect-url
Lidar com solicitações de autorização de páginas da web. Para a configuração relevante da conta pública, consulte a documentação do WeChat. O URL de retorno de chamada precisa apenas do nome de domínio onde wx-gateway
está localizado
redirect-url
configura um URL, como
redirect-url
é http://wx.myhost.com/menu/path/to/redirect
wx-gateway
recebe uma solicitação de página da web, ele encaminhará a mensagem para o URL acimaPOST
. O resultado da resposta é completamente determinado pelo serviço de processamento de encaminhamento. O resultado da resposta HTTP será refletido no navegador da conta pública. Para que wx-gateway
receba eventos de clique no menu, a URL deve ser escrita no formato autorizado pela página oficial da conta:
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
estiver configurado corretamente ele poderá receber eventos de menu, obter o openId do usuário que clicou no menu através do código e encaminhá-lo para a redirect-url
Solicitar formato de mensagem para solicitar 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时的错误信息,如果为空表示没有错误"
}
Todos os cabeçalhos de solicitação HTTP e cookies serão encaminhados para redirect-url
, que pode ser processado de acordo com a necessidade
Formato da mensagem de resultado de resposta
redirect-url
, incluindo