Consignes concernant Postman pour les API

Postman améliore considérablement la capacité à tester et comprendre les API Merchant en fournissant une interface conviviale pour construire, envoyer et analyser les requêtes HTTP. Vous pouvez facilement créer et modifier différents appels d'API (GET, POST, PUT, DELETE) vers différents points de terminaison, en ajustant les paramètres, les en-têtes et les corps de requête pour simuler des scénarios réels.

La présentation claire des réponses de l'outil, y compris les codes d'état, les en-têtes et les charges utiles, permet de vérifier rapidement le comportement de l'API et facilite le débogage des problèmes. Cette approche structurée accélère le cycle de vie du développement, améliore la qualité de l'API et permet de mieux comprendre les capacités et les subtilités de l'API Merchant.

Présentation

Pour utiliser la collection Postman MAPI sur votre instance Postman, vous devez suivre quelques étapes pour configurer l'environnement. Voici les instructions détaillées à suivre.

Pour en savoir plus sur la plate-forme, consultez la description de Postman.

1. Configuration du compte de service

Vous obtiendrez serviceAccountKey et api_key.

  1. Pour obtenir des instructions détaillées, consultez Utiliser un compte de service pour accéder à l'API.
  2. Dans votre projet Google Cloud > Identifiants > Créer des identifiants > Compte de service
  3. Remplissez le formulaire, puis cliquez sur Créer et continuer.
  4. Sélectionnez le rôle Propriétaire, puis cliquez sur Continuer.
  5. Cliquez sur Terminé.
  6. Pour télécharger la clé JSON, procédez comme suit :
    1. Cliquez sur l'adresse e-mail du compte de service que vous venez de créer (par exemple, {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com).
    2. Cliquez sur l'onglet Clés.
    3. Cliquez sur Ajouter une clé > Créer une clé.
    4. Sélectionnez JSON, puis cliquez sur Créer pour télécharger le fichier JSON.

AVERTISSEMENT : Vous ne pouvez télécharger la clé qu'une seule fois. Si vous la perdez, vous devrez en créer une autre et supprimer celle-ci.

  1. Ouvrez Merchant Center.
  2. Dans Paramètres > Accès et services, cliquez sur Utilisateurs et accès.
  3. Cliquez sur Ajouter une personne, puis utilisez l'ID de compte de service comme adresse e-mail du nouvel utilisateur.

2. Configurer Postman

  1. Téléchargez le fichier JSON du modèle d'environnement Postman.
  2. Téléchargez le fichier JSON de la collection Postman MAPI.
  3. Connectez-vous à Postman ou créez un compte.
  4. Importer un modèle d'environnement Postman
    1. Copiez votre fichier JSON complet dans Environment > MyAccount > serviceAccountKey.
    2. Copiez votre private_key depuis le fichier JSON dans la collection Environment > MyAccount > api_key.
  5. Importer le fichier JSON de la collection Postman MAPI
  6. Sélectionnez l'environnement en haut à droite.

3. Enregistrement des développeurs

Associez votre compte Merchant Center au projet Google Cloud en vous inscrivant en tant que développeur. Les utilisateurs disposant du rôle de développeur d'API recevront des communications sur l'API, y compris des annonces obligatoires sur le service, des enquêtes à leur attention et des opportunités.

  1. Ouvrez Postman > Collections > Merchant API Official.
  2. Ouvrez accounts_v1 > accounts > accounts.developerRegistration > registerGcp.
  3. Remplacez l'espace réservé {account} dans le chemin d'accès par votre numéro client CM.
  4. Remplacez l'espace réservé {email} dans le corps du message par votre adresse e-mail.
  5. Cliquez sur Envoyer pour enregistrer l'appareil.
  6. Si tout s'est bien passé, vous recevrez une réponse JSON de confirmation semblable à celle-ci : json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. Tester l'API Merchant sur Postman

  1. Ouvrez Postman > Collections > Merchant API Official > accounts_v1 > accounts > list.
  2. Cliquez sur Envoyer.
  3. Si tout s'est bien passé, vous recevrez une réponse JSON de confirmation semblable à celle-ci : json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }