wechatpay postman script

Script Postman APIv3 de paiement WeChat

WeChat Payment APIv3 Postman demande un script de pré-demande (Script de pré-demande).

Afin d'aider les développeurs marchands à démarrer rapidement, nous déployons le script sur l'espace de travail public WeChat Pay de l'atelier cloud Postman. Vous n'avez pas besoin d'importer manuellement le script, il vous suffit de créer la collection « WeChat Payment APIv3 » sur votre workbench, et vous pouvez facilement créer et envoyer des requêtes WeChat Payment APIv3 sur Postman.

Conditions préalables

• Postman, une plateforme renommée du secteur pour la création et l'utilisation d'API. Il est recommandé de créer un compte pour utiliser ses différentes fonctions.
• Devenez un marchand de paiement WeChat.
• Clé privée de l'API marchand : lorsqu'un commerçant demande un certificat API marchand, la clé privée du marchand sera générée et enregistrée dans le fichier apiclient_key.pem dans le dossier du certificat local.

démarrage rapide

Étape 1 : Script d'importation Fork

Cliquez sur le bouton pour accéder à l'assistant, comme indiqué ci-dessous.

Cliquez sur Fork Collection pour passer à l'étape suivante, remplissez l'étiquette Fork Label et sélectionnez l' Workspace de travail de destination Workspace . Dans des circonstances normales, il suffit d'importer l'atelier personnel Mon espace de travail.

Cliquez sur Fork Collection pour terminer l’importation. Vous pouvez voir « WeChat Payment APIv3 » dans votre espace de travail désigné.

Vous pouvez également importer des scripts localement.

Étape 2 : configurer l'environnement

L'environnement est un ensemble de variables. Le script lit les variables de l'environnement et les utilise pour calculer la signature de la requête.

Vous pouvez créer un environnement vide à partir du modèle de paramètres marchand fourni par « WeChat Payment APIv3 » vers votre propre workbench.

Ensuite, recherchez l'environnement nouvellement créé dans Environnements sur votre workbench et cliquez sur Add a new varialbe pour ajouter une nouvelle variable :

• mchid : obligatoire, numéro de commerçant.
• merchant_serial_no : obligatoire, numéro de série du certificat API du commerçant.
• apiclient_key.pem : Obligatoire, clé privée API marchand au format PEM.

AvertissementPour votre sécurité, veuillez lire attentivement les précautions de sécurité.

Un ensemble commun de configurations est présenté ci-dessous.

Étape 3 : Envoyer une demande

Remarque : Nous vous recommandons d'utiliser l'application de bureau Postman pour envoyer des demandes, ce qui est plus rapide et offre une meilleure expérience !

Revenez maintenant au workbench, entrez dans la collection « WeChat Payment APIv3 » et sélectionnez la demande que vous souhaitez envoyer.

Ensuite, renseignez les paramètres de la demande et modifiez les paramètres dans le Corps en fonction des commentaires.

Enfin, sélectionnez l'environnement que vous avez configuré précédemment et cliquez sur le bouton Send sur le côté droit de la barre d'adresse pour envoyer la demande.

Principe de mise en œuvre

Pre-Request Script est un script Javascript. Postman exécute ce script avant d'envoyer la demande. Le script effectue les opérations suivantes :

1. Charger les bibliothèques dépendantes
2. Lire les variables des paramètres du commerçant dans Environnement
3. Construisez une chaîne de signature basée sur la méthode demandée, l'URL, les paramètres, le corps et d'autres informations, et calculez la signature de la demande
4. Définir Authorization de l'en-tête de la demande

RemarquePour plus d'informations sur les scripts Postman, voir Scripts dans Postman.

variable de paramètre

nom de la variable	Est-ce obligatoire ?	décrire	Remarque
mchid	Oui	Numéro de commerçant
marchand_serial_no	Oui	Numéro de série du certificat API du commerçant
apiclient_key.pem	Oui	Clé privée de l'API marchand au format PEM
identifiant ouvert	Non	L'OpenID de l'utilisateur, {{openid}} dans la requête de test
application	Non	AppID du compte public ou du mini programme
Shangmi	Non	Utiliser une signature secrète commerciale lorsque la valeur est true	La valeur par défaut est vide, ce qui signifie utiliser la signature RSA
pubkey.pem	Obligatoire lors de la signature avec des secrets d'État	Clé publique de l'API marchand au format PEM	Si la clé privée PEM contient la clé publique, cette variable n'a pas besoin d'être renseignée
URL_serveur	Non	Adresse du serveur	Le paramètre par défaut est https://api.mch.weixin.qq.com

Bibliothèques dépendantes

Le script utilise directement :

• forge.min.js, PKI, RSA et ASN.1 pour forge.
• sm2.js, la signature SM2 de la bibliothèque secrète nationale TencentSM-javascript.

Afin d'éviter de télécharger des bibliothèques dépendantes à chaque requête, les deux bibliothèques sont stockées dans les variables de collection en tant que code source. Cela réduit considérablement le temps nécessaire à l'envoi des demandes à l'aide de la version Web de Postman.

Précautions de sécurité

Les clés privées de l’API marchand sont des informations très sensibles. Lorsque vous utilisez ce code, vous devez garder les points suivants à l’esprit :

• Définissez la visibilité de l'espace de travail configuré avec la clé privée sur Personal ou Private , et ne la définissez pas sur Public .
• Le type de variable de la clé privée est défini sur secret . Les valeurs des variables sont affichées à l'écran sous forme de masque.
• La valeur variable de la clé privée est définie dans Current Value . Current Value est uniquement enregistrée dans la session locale et ne sera pas envoyée au serveur Postman.
• Si vous utilisez un script Postman de quelqu'un d'autre, veuillez vérifier les bibliothèques, variables et scripts dépendants pour vous assurer qu'ils n'ont pas été modifiés afin d'éviter d'implanter du code dangereux.

RemarquePour plus d'informations sur le mécanisme de sécurité de Postman, veuillez vous référer à Postman Security.

Comment lancer une demande de secrets d'État

Utilisez le modèle de paramètre National Secret-Merchant et définissez-le dans la variable d'environnement :

• shangmi : La valeur est true .
• mchid : obligatoire, numéro de commerçant.
• merchant_serial_no : obligatoire, numéro de série du certificat API du commerçant.
• apiclient_key.pem : Obligatoire, clé privée API marchand au format PEM.
• pubkey.pem : obligatoire, clé publique secrète nationale de l'API marchand au format PEM.

De cette façon, le script utilisera le secret national SM2 pour calculer la signature et envoyer la demande de secret national.

script d'importation local

Remarque : Il n'est pas recommandé d'importer des scripts localement. Cette opération est fastidieuse et sujette aux erreurs et ne permet pas de synchroniser les modifications en amont.

L’importation de Fork Collection nécessite l’enregistrement d’un compte Postman. Si vous ne souhaitez pas vous inscrire, vous pouvez importer le script localement.

Tout d’abord, ouvrez la collection WeChatPay APIv3, développez les options et cliquez sur Exporter :

Téléchargez et enregistrez le fichier wechatpay-apiv3.postman_collection.json localement. Ensuite, il existe deux manières d’importer le fichier JSON localement :

• Le bouton Import dans le coin supérieur gauche de l’interface Postman
• Menu File > Import lance l'importation

Sélectionnez le fichier local wechatpay-apiv3.postman_collection.json et cliquez sur Confirmer pour terminer l'importation.

Vous constaterez qu'un nouvel ensemble de requêtes nommé « WeChatPay APIv3 » a été ajouté aux collections sur le workbench. Après avoir configuré l'environnement, vous pouvez envoyer la demande.

Synchroniser les modifications en amont

Nous ajouterons progressivement de nouvelles interfaces et mettrons à jour les interfaces existantes, mais la branche de collection que vous branchez à votre workbench ne synchronisera pas automatiquement les modifications en amont. Il est recommandé de watch notre espace de travail public afin de recevoir des notifications du facteur lorsque des modifications en amont sont apportées.

À ce stade, vous pouvez utiliser pull changes pour extraire les modifications en amont.

pull changes par Postman peuvent prendre un certain temps. Si vous rencontrez des problèmes, re-forker est également une bonne idée.

FAQ

Lors de l'envoi d'une requête, un message d'erreur « Erreur : trop peu d'octets pour analyser DER » ou « Trop peu d'octets pour lire la valeur ASN.1 » est rencontré.

Cela est généralement dû à un remplissage incorrect de la variable merchantPrivateKey configurée dans l'environnement. La clé privée reçue par le script est une chaîne commençant par -----BEGIN PRIVATEKEY----- et se terminant par -----END PRIVATE KEY----- .

Pourquoi ma demande d'envoi est-elle si lente ?

Si vous utilisez la version Web de Postman, veuillez utiliser l'application de bureau Postman. En raison des limitations du partage de ressources cross-origin (CORS) dans les navigateurs, les requêtes envoyées par la version Web sont transmises par Postman en arrière-plan.

Ou utilisez l'agent de bureau Postman. Pour plus d'informations, veuillez consulter les blogs liés à Postman.

Contactez-nous

Si vous avez des questions, veuillez visiter notre communauté de développeurs pour obtenir des commentaires.

Nous acceptons également toutes sortes de problèmes et de demandes de fusion :-)