wechatpay postman script

Script Postman APIv3 de pagamento WeChat

WeChat Payment APIv3 Postman solicita script de pré-solicitação (Script de pré-solicitação).

Para ajudar os desenvolvedores comerciais a começarem rapidamente, implantamos o script no ambiente de trabalho em nuvem Postman WeChat Pay Public Workspace. Você não precisa importar manualmente o script, você só precisa bifurcar a coleção "WeChat Payment APIv3" em seu ambiente de trabalho e pode facilmente construir e enviar solicitações WeChat Payment APIv3 no Postman.

Pré-condições

• Postman, uma plataforma renomada no setor para construção e uso de APIs. Recomenda-se registrar uma conta para utilizar suas diversas funções.
• Torne-se um comerciante de pagamentos WeChat.
• Chave privada da API do comerciante: quando um comerciante solicita um certificado da API do comerciante, a chave privada do comerciante será gerada e salva no arquivo apiclient_key.pem na pasta de certificado local.

início rápido

Etapa 1: script de importação de fork

Clique no botão para entrar no assistente, conforme mostrado abaixo.

Clique em Fork Collection para prosseguir para a próxima etapa, preencha o rótulo Fork Label e selecione o Workspace . Em circunstâncias normais, basta importar o ambiente de trabalho pessoal My Workspace.

Clique em Fork Collection para concluir a importação. Você pode ver "WeChat Payment APIv3" em seu espaço de trabalho designado.

Você também pode importar scripts localmente.

Etapa 2: configurar o ambiente

O ambiente é uma coleção de variáveis. O script lê variáveis ​​do ambiente e as utiliza para calcular a assinatura da solicitação.

Você pode bifurcar um ambiente vazio do modelo de parâmetro do comerciante fornecido pelo "WeChat Payment APIv3" para seu próprio ambiente de trabalho.

Em seguida, encontre o ambiente recém-criado em Ambientes no seu ambiente de trabalho e clique em Add a new varialbe para adicionar uma nova variável:

• mchid : obrigatório, número do comerciante.
• merchant_serial_no : obrigatório, número de série do certificado da API do comerciante.
• apiclient_key.pem : chave privada da API do comerciante obrigatória no formato PEM.

AvisoPara segurança, leia atentamente as precauções de segurança.

Um conjunto comum de configurações é mostrado abaixo.

Etapa 3: envie uma solicitação

Nota: Recomendamos usar o aplicativo Postman para desktop para enviar solicitações, que é mais rápido e oferece uma experiência melhor!

Agora retorne ao ambiente de trabalho, entre na coleção "WeChat Payment APIv3" e selecione a solicitação que deseja enviar.

Em seguida, preencha os parâmetros da solicitação e modifique os parâmetros no Corpo de acordo com os comentários.

Por fim, selecione o Ambiente que você configurou anteriormente e clique no botão Send no lado direito da barra de endereço para enviar a solicitação.

Princípio de implementação

Pre-Request Script é um script Javascript. Postman executa este script antes de enviar a solicitação. O script faz o seguinte:

1. Carregar bibliotecas dependentes
2. Leia as variáveis ​​de parâmetro do comerciante em Ambiente
3. Construa uma string de assinatura com base no método solicitado, URL, parâmetros, corpo e outras informações e calcule a assinatura da solicitação
4. Definir Authorization do cabeçalho da solicitação

ObservaçãoPara obter mais informações sobre scripts do Postman, consulte Scripts no Postman.

variável de parâmetro

nome da variável	É obrigatório?	descrever	Observação
mchid	sim	Número do comerciante
comerciante_serial_no	sim	Número de série do certificado da API do comerciante
apiclient_key.pem	sim	Chave privada da API Merchant em formato PEM
código aberto	não	O OpenID do usuário, {{openid}} na solicitação de teste
aplicativo	não	AppID da conta pública ou miniprograma
Shangmi	não	Use assinatura de segredo comercial quando o valor for true	O valor padrão está vazio, o que significa usar assinatura RSA
pubkey.pem	Obrigatório ao assinar com segredos de estado	Chave pública da API Merchant em formato PEM	Se a chave privada PEM contém a chave pública, esta variável não precisa ser preenchida
URL_do_servidor	não	Endereço do servidor	A configuração padrão é https://api.mch.weixin.qq.com

Bibliotecas dependentes

O script usa diretamente:

• forge.min.js, PKI, RSA e ASN.1 para forge.
• sm2.js, a assinatura SM2 da biblioteca secreta nacional da Tencent, TencentSM-javascript.

Para evitar o download de bibliotecas dependentes a cada solicitação, as duas bibliotecas são armazenadas em Collection Variables como código-fonte. Isso reduz bastante o tempo necessário para enviar solicitações usando a versão web do Postman.

Precauções de segurança

As chaves privadas da API do comerciante são informações muito confidenciais. Ao usar este código, você deve manter os seguintes pontos em mente:

• Defina a visibilidade do espaço de trabalho configurado com a chave privada como Personal ou Private e não a configure como Public .
• O tipo de variável da chave privada é definido como secret . Os valores das variáveis ​​são exibidos na tela em forma de máscara.
• O valor variável da chave privada é definido em Current Value . Current Value é salvo apenas na sessão local e não será enviado ao servidor Postman.
• Se você usar um script Postman de outra pessoa, verifique as bibliotecas, variáveis ​​e scripts dependentes para ter certeza de que não foram modificados para evitar a implantação de código inseguro.

ObservaçãoPara obter informações sobre o mecanismo de segurança do Postman, consulte Postman Security.

Como iniciar uma solicitação de segredos de estado

Use o modelo de parâmetro National Secret-Merchant e defina-o na variável de ambiente:

• shangmi : O valor é true .
• mchid : obrigatório, número do comerciante.
• merchant_serial_no : obrigatório, número de série do certificado da API do comerciante.
• apiclient_key.pem : chave privada da API do comerciante obrigatória no formato PEM.
• pubkey.pem : chave pública secreta nacional obrigatória da API do comerciante no formato PEM.

Desta forma, o script utilizará o segredo nacional SM2 para calcular a assinatura e enviar a solicitação do segredo nacional.

script de importação local

Nota: Não é recomendado importar scripts localmente. É complicado e sujeito a erros e não pode sincronizar alterações upstream.

A importação da Fork Collection requer o registro de uma conta Postman. Se não quiser se registrar, você pode importar o script localmente.

Primeiro, abra a coleção WeChatPay APIv3, expanda as opções e clique em Exportar:

Baixe e salve o arquivo wechatpay-apiv3.postman_collection.json localmente. Existem duas maneiras de importar o arquivo JSON localmente:

• O botão Import no canto superior esquerdo da interface do Postman
• Menu File > Import inicia a importação

Selecione o wechatpay-apiv3.postman_collection.json local e clique em Confirmar para concluir a importação.

Você descobrirá que um novo conjunto de solicitações chamado "WeChatPay APIv3" foi adicionado às Coleções no ambiente de trabalho. Após configurar o Ambiente, você pode enviar a solicitação.

Sincronizar alterações upstream

Adicionaremos gradualmente novas interfaces e atualizaremos as interfaces existentes, mas a ramificação de coleção que você bifurca em seu ambiente de trabalho não sincronizará automaticamente as alterações upstream. Recomenda-se watch nosso Espaço de Trabalho Público para receber notificações do carteiro quando forem feitas alterações no upstream.

Neste momento, você pode usar pull changes para extrair as alterações upstream.

pull changes do Postman podem levar algum tempo para serem concluídas. Se você encontrar problemas, a nova bifurcação também é uma boa ideia.

Perguntas frequentes

Ao enviar uma solicitação, é encontrada uma mensagem de erro "Erro: Poucos bytes para analisar DER." ou "Poucos bytes para ler o valor ASN.1".

Geralmente é causado pelo preenchimento incorreto da variável merchantPrivateKey configurada no Ambiente. A chave privada recebida pelo script é uma string começando com -----BEGIN PRIVATEKEY----- e terminando com -----END PRIVATE KEY----- .

Por que minha solicitação de envio é tão lenta?

Se você estiver usando a versão web do Postman, use o aplicativo Postman para desktop. Devido às limitações do compartilhamento de recursos entre origens (CORS) nos navegadores, as solicitações enviadas pela versão web são encaminhadas pelo Postman em segundo plano.

Ou use o agente de desktop Postman. Para obter mais informações, consulte os blogs relacionados ao Postman.

Contate-nos

Se você tiver alguma dúvida, visite nossa comunidade de desenvolvedores para obter feedback.

Também acolhemos todos os tipos de problemas e solicitações de mesclagem :-)