API Postman Guidelines

Postman migliora notevolmente la capacità di testare e comprendere le API Merchant fornendo un'interfaccia user-friendly per creare, inviare e analizzare le richieste HTTP. Puoi creare e modificare facilmente varie chiamate API (GET, POST, PUT, DELETE) a diversi endpoint, modificando parametri, intestazioni e corpi delle richieste per simulare scenari reali.

La presentazione chiara delle risposte dello strumento, inclusi codici di stato, intestazioni e payload, consente una rapida verifica del comportamento dell'API e aiuta a eseguire il debug dei problemi. Questo approccio strutturato accelera il ciclo di vita dello sviluppo, migliora la qualità delle API e approfondisce la comprensione delle funzionalità e delle complessità dell'API Merchant.

Panoramica

Per utilizzare la raccolta MAPI Postman nella tua istanza di Postman, devi seguire alcuni passaggi per configurare prima l'ambiente. Ecco una guida passo passo su come procedere.

Per saperne di più sulla piattaforma, consulta la descrizione di Postman.

1. Configurazione del service account

Riceverai serviceAccountKey e api_key

  1. Per i passaggi dettagliati, segui come utilizzare un service account per accedere all'API
  2. Nel tuo progetto Google Cloud > Credenziali > Crea credenziali > Service account
  3. Compila il modulo e fai clic su Crea e continua.
  4. Seleziona il ruolo Proprietario e fai clic su Continua.
  5. Fai clic su Fine.
  6. Per scaricare la chiave JSON:
    1. Fai clic sull'email dell'account di servizio appena creato (ad esempio {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com).
    2. Fai clic sulla scheda Chiavi.
    3. Fai clic su Aggiungi chiave > Crea chiave.
    4. Seleziona JSON e fai clic su Crea per scaricare il file JSON.

AVVISO: puoi scaricare la chiave solo una volta. Se la perdi, devi crearne una nuova ed eliminare quella precedente.

  1. Apri Merchant Center.
  2. In Impostazioni > Accesso e servizi, fai clic su Persone e accesso.
  3. Fai clic su Aggiungi persona e utilizza l'ID service account come indirizzo email per il nuovo utente.

2. Configurazione di Postman

  1. Scarica il modello JSON dell'ambiente Postman
  2. Scarica il file JSON della raccolta Postman dell'API Maps
  3. Accedi a Postman o crea un nuovo account
  4. Importa il modello di ambiente Postman
    1. Copia il JSON completo in Environment > MyAccount > serviceAccountKey
    2. Copia private_key dal file JSON nella raccolta Environment > MyAccount > api_key
  5. Importa JSON della raccolta Postman MAPI
  6. Seleziona l'ambiente nell'angolo in alto a destra.

3. Registrazione sviluppatore

Collega il tuo account Merchant Center al progetto Google Cloud registrandoti come sviluppatore. Gli utenti con il ruolo di sviluppatore API riceveranno comunicazioni API, inclusi annunci di servizio obbligatori, sondaggi per sviluppatori e opportunità.

  1. Apri Postman > Raccolte > API Merchant ufficiale
  2. Apri accounts_v1 > accounts > accounts.developerRegistration > registerGcp
  3. Sostituisci il segnaposto {account} nel percorso con il tuo ID cliente
  4. Sostituisci il segnaposto {email} nel corpo con il tuo indirizzo email.
  5. Fai clic su Invia per eseguire la registrazione.
  6. Se tutto è stato eseguito correttamente, riceverai una risposta JSON di conferma come questa: json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. Testare l'API Merchant su Postman

  1. Apri Postman > Raccolte > API Merchant ufficiale > accounts_v1 > accounts > list
  2. Fai clic su Invia
  3. Se tutto è stato eseguito correttamente, riceverai una risposta JSON di conferma come questa: json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }