O Cloudflare-WX-API é um projeto de código aberto hospedado no GitHub que visa ajudar os desenvolvedores a combinar o WeChat Service Number com a plataforma Cloudflare para obter login CAPTCHA, login de varredura de código e funções inteligentes de resposta automática com base no Large Language Model (LLM). Desenvolvido pela Tinger-X, o projeto é adequado para desenvolvedores individuais ou pequenas equipes criarem rapidamente recursos de automação para o WeChat Service Number. O projeto usa o Cloudflare Workers para fornecer suporte eficiente no lado do servidor, combinado com a API do WeChat para obter autenticação de usuário e processamento de mensagens. Ao integrar o LLM, os desenvolvedores podem obter respostas inteligentes às mensagens e melhorar a experiência de interação do usuário. Todo o projeto tem como objetivo ser simples e fácil de usar, com código aberto e documentação clara, adequado para usuários com uma certa base de programação.
Lista de funções
- Acesso ao número de serviço do WeChat: suporte à configuração rápida do número de serviço do WeChat, encaixe completo da API.
- Login CAPTCHA: forneça a função de login CAPTCHA baseada no WeChat para simplificar o processo de autenticação do usuário.
- Login por código de leitura: permite que os usuários façam login por meio do código de leitura do WeChat, adequado para verificação rápida de identidade em vários cenários.
- Respostas automáticas inteligentes: integração de modelagem de linguagem ampla (LLM) para respostas inteligentes a mensagens sensíveis ao contexto.
- Suporte a Cloudflare Workers: aproveita a arquitetura sem servidor da Cloudflare para uma implementação eficiente e de baixo custo.
- Código-fonte aberto: o código completo e a documentação são fornecidos para que os desenvolvedores personalizem a funcionalidade.
- Configuração leve: a configuração inicial pode ser feita com um arquivo de configuração simples.
Usando a Ajuda
Instalação e configuração
Para usar o Cloudflare-WX-API, primeiro você precisa preparar o seguinte ambiente:
- Conta do GitHub: Acesso
https://github.com/Tinger-X/cloudflare-wx-api
Clique em "Fork" ou "Clone" para fazer o download do projeto localmente. - Conta da CloudflareRegistre-se em uma conta da Cloudflare e habilite o recurso Workers. Faça login no painel da Cloudflare e acesse a página "Workers" para criar um novo projeto.
- Plataforma para desenvolvedores do WeChatRegistre-se em uma conta da plataforma pública WeChat, crie um número de serviço e obtenha um AppID e um AppSecret.
- Ambiente Node.jsVerifique se o Node.js (versão recomendada 16 ou superior) está instalado localmente para executar e testar o projeto.
Etapas de instalação::
- Clonagem de projeto para local:
git clone https://github.com/Tinger-X/cloudflare-wx-api.git cd cloudflare-wx-api
- Instale a dependência:
npm install
- Configurar variáveis de ambiente:
- No diretório raiz do projeto, crie o arquivo
.env
adicione o seguinte:WECHAT_APP_ID=你的微信AppID WECHAT_APP_SECRET=你的微信AppSecret CLOUDFLARE_API_TOKEN=你的Cloudflare API令牌 LLM_API_KEY=你的LLM服务API密钥
- No diretório raiz do projeto, crie o arquivo
- Implantar no Cloudflare Workers:
- Faça login usando a ferramenta Wrangler CLI (ferramenta de linha de comando da Cloudflare):
npx wrangler login
- Projetos de implantação:
npx wrangler deploy
- Quando a implantação é concluída, o Wrangler retorna um URL (por exemplo
https://your-project.workers.dev
) para a configuração do número de serviço da Microsoft.
- Faça login usando a ferramenta Wrangler CLI (ferramenta de linha de comando da Cloudflare):
Configuração do número de serviço do WeChat::
- Faça login na WeChat Public Platform e vá para "Development - Basic Configuration" (Desenvolvimento - Configuração básica).
- Em "Server Configuration" (Configuração do servidor), preencha os seguintes campos:
- Endereço do servidor (URL)Preencha o URL fornecido pelo Cloudflare Workers.
- TokenPersonalize as configurações no arquivo de configuração do projeto.
- chave de criptografia e descriptografia de mensagensGerar uma chave aleatória e salvá-la.
- Envie a configuração e verifique se o servidor está conectado com êxito ao número de serviço do WeChat.
Função Fluxo de operação
Login CAPTCHA
- O usuário aciona uma solicitação de login no front-end e o sistema envia um código de verificação para o WeChat do usuário.
- O usuário insere um código de verificação e o projeto é aprovado
/verify
Código de verificação da soma de verificação do ponto de extremidade. - Após a autenticação bem-sucedida, as informações de autenticação do usuário (como OpenID) são retornadas para operações subsequentes.
- Exemplo de operação: os usuários visitam sua página da Web, clicam em "WeChat Login", digitam o código de verificação recebido e o sistema conclui automaticamente a verificação de identidade.
Passe o dedo para fazer login.
- O projeto gera um código QR dinâmico que os usuários escaneiam usando o WeChat.
- Após a varredura, o servidor WeChat chama de volta o URL configurado pelo projeto para passar as informações de identidade do usuário.
- O sistema lida com os retornos de chamada e conclui o login do usuário.
- Exemplo de operação: o usuário escaneia o código QR na página da Web, o WeChat salta para a página de autorização e faz login automaticamente após a confirmação.
Respondedor automático inteligente
- O usuário envia uma mensagem para o número de serviço do WeChat, acionando o Cloudflare Workers para processá-la.
- O projeto chama a API do LLM (por exemplo, OpenAI ou outros modelos) para gerar respostas sensíveis ao contexto.
- A resposta é retornada ao usuário por meio da API do WeChat.
- Exemplo de operação: O usuário envia "What's the weather tomorrow?" (Como estará o tempo amanhã?) o número de serviço responde: "Digite o nome da cidade e eu verificarei o tempo para você" ou retorna as informações meteorológicas diretamente.
Personalização
O desenvolvedor pode modificar index.js
para adicionar lógica personalizada. Por exemplo, adicionar filtragem de mensagens, acionamento de palavras-chave ou suporte a vários idiomas. O projeto suporta extensão modular, os desenvolvedores podem acessar outras APIs de acordo com a demanda.
advertência
- segurançaPara garantir que
.env
A chave do arquivo não é divulgada e o upload para repositórios públicos é evitado. - ajustar os componentes durante o teste: Uso
npx wrangler dev
Teste a funcionalidade do Workers localmente. - referência de documentaçãoDocumentação detalhada está disponível na página do projeto no GitHub, em
README.md
responder cantandoDOCS
Pasta. - Atualização de manutençãoVerifique periodicamente a compatibilidade de versões entre o Cloudflare Workers e a API do WeChat.
cenário do aplicativo
- Os desenvolvedores individuais criam rapidamente o número de serviço do WeChat
Os desenvolvedores individuais podem usar o Cloudflare-WX-API para implementar rapidamente as funções de login do número do serviço WeChat e de resposta a mensagens, sem configurações complexas de servidor, adequadas para prototipagem rápida. - Autenticação do usuário da plataforma de comércio eletrônico
Os sites de comércio eletrônico podem simplificar o processo de autenticação do usuário, aprimorar a experiência do usuário e reduzir o limite de registro por meio do login por código de leitura ou login por código de verificação. - Sistema inteligente de atendimento ao cliente
As empresas podem usar autoresponders inteligentes para criar um sistema de atendimento ao cliente 24 horas por dia, 7 dias por semana, para responder a perguntas frequentes e reduzir o ônus do atendimento manual ao cliente. - Plataformas educacionais ou de interação com a comunidade
As plataformas de educação on-line ou de comunidade podem interagir com os usuários por meio dos números de serviço do WeChat, enviar lembretes de cursos ou notificações de eventos e fornecer respostas personalizadas por meio do LLM.
QA
- Precisa de um servidor?
Não é necessário. O projeto é baseado no Cloudflare Workers, que elimina a necessidade de servidores tradicionais e torna a implantação fácil e econômica. - Quais modelos de linguagem grandes são suportados?
O projeto é compatível com qualquer LLM que forneça uma API, como OpenAI, Anthropic, etc., que precisa ser adicionada no.env
Configure a chave da API na seção - Como depurar callbacks da Microsoft?
fazer uso denpx wrangler dev
Inicie o servidor local e verifique a função de retorno de chamada em conjunto com o número de teste da plataforma pública do WeChat. - Ele oferece suporte a respostas em vários idiomas?
Suporte padrão para respostas em chinês, os desenvolvedores podem modificar o código para acessar o LLM multilíngue ou a API de tradução.