Postman-Richtlinien für APIs

Postman bietet eine benutzerfreundliche Oberfläche zum Erstellen, Senden und Analysieren von HTTP-Anfragen und erleichtert so das Testen und Verstehen von Merchant APIs erheblich. Sie können ganz einfach verschiedene API-Aufrufe (GET, POST, PUT, DELETE) an unterschiedliche Endpunkte erstellen und ändern. Dazu passen Sie Parameter, Header und Anfragetexte an, um reale Szenarien zu simulieren.

Die übersichtliche Darstellung von Antworten im Tool, einschließlich Statuscodes, Headern und Nutzlasten, ermöglicht eine schnelle Überprüfung des API-Verhaltens und hilft bei der Fehlerbehebung. Dieser strukturierte Ansatz beschleunigt den Entwicklungszyklus, verbessert die API-Qualität und vertieft das Verständnis der Funktionen und Feinheiten der Merchant API.

Übersicht

Wenn Sie die MAPI-Postman-Sammlung in Ihrer Postman-Instanz verwenden möchten, müssen Sie zuerst die Umgebung konfigurieren. Hier finden Sie eine detaillierte Anleitung dazu.

Weitere Informationen zur Plattform finden Sie in der Postman-Beschreibung.

1. Dienstkontokonfiguration

Sie erhalten den serviceAccountKey und den api_key.

  1. Eine detaillierte Anleitung finden Sie unter Dienstkonto für den Zugriff auf die API verwenden.
  2. Google Cloud-Projekt > Anmeldedaten > Anmeldedaten erstellen > Dienstkonto
  3. Füllen Sie das Formular aus und klicken Sie auf Erstellen und fortfahren.
  4. Wählen Sie die Rolle Inhaber aus und klicken Sie auf Weiter.
  5. Klicken Sie auf Fertig.
  6. So laden Sie den JSON-Schlüssel herunter:
    1. Klicken Sie auf die gerade erstellte E-Mail-Adresse des Dienstkontos (etwa {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com).
    2. Klicken Sie auf den Tab Schlüssel.
    3. Klicken Sie auf Schlüssel hinzufügen > Schlüssel erstellen.
    4. Wählen Sie JSON aus und klicken Sie auf Erstellen, um die JSON-Datei herunterzuladen.

ACHTUNG: Sie können den Schlüssel nur einmal herunterladen. Wenn Sie ihn verlieren, müssen Sie einen neuen Schlüssel erstellen und diesen löschen.

  1. Öffnen Sie das Merchant Center.
  2. Klicken Sie unter Einstellungen > Zugriff und Dienst auf Personen und Zugriff.
  3. Klicken Sie auf Person hinzufügen und verwenden Sie die Dienstkonto-ID als E-Mail-Adresse für den neuen Nutzer.

2. Postman einrichten

  1. Postman-Umgebungsvorlage als JSON herunterladen
  2. MAPI Postman-Sammlung als JSON herunterladen
  3. Melden Sie sich in Postman an oder erstellen Sie ein neues Konto.
  4. Postman-Umgebungsvorlage importieren
    1. Kopieren Sie die vollständige JSON-Datei in Umgebung > Mein Konto > serviceAccountKey.
    2. Kopieren Sie den private_key aus der JSON-Datei in die Sammlung > Umgebung > MyAccount > api_key.
  5. MAPI Postman Collection-JSON importieren
  6. Wählen Sie rechts oben die Umgebung aus.

3. Entwicklerregistrierung

Verknüpfen Sie Ihr Merchant Center-Konto mit dem Google Cloud-Projekt, indem Sie sich als Entwickler registrieren. Nutzer mit der Rolle „API-Entwickler“ erhalten API-Mitteilungen, darunter obligatorische Servicemitteilungen, Entwicklerumfragen und Informationen zu Möglichkeiten.

  1. Öffnen Sie Postman > Collections > Merchant API Official.
  2. Öffnen Sie accounts_v1 > accounts > accounts.developerRegistration > registerGcp.
  3. Ersetzen Sie den Platzhalter {account} im Pfad durch Ihre MC-ID.
  4. Ersetzen Sie den Platzhalter {email} im Text durch Ihre E-Mail-Adresse.
  5. Klicken Sie auf Senden, um die Registrierung auszuführen.
  6. Wenn alles richtig gemacht wurde, erhalten Sie eine Bestätigungs-JSON-Antwort wie diese: json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. Merchant API in Postman testen

  1. Öffnen Sie Postman > Collections > Merchant API Official > accounts_v1 > accounts > list.
  2. Klicken Sie auf Senden.
  3. Wenn alles richtig gemacht wurde, erhalten Sie eine Bestätigungs-JSON-Antwort wie diese: json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }