Wytyczne dotyczące interfejsu API Postman

Postman znacznie zwiększa możliwości testowania i poznawania interfejsów API sprzedawcy, ponieważ udostępnia przyjazny dla użytkownika interfejs do tworzenia, wysyłania i analizowania żądań HTTP. Możesz łatwo tworzyć i modyfikować różne wywołania interfejsu API (GET, POST, PUT, DELETE) do różnych punktów końcowych, dostosowując parametry, nagłówki i treści żądań, aby symulować rzeczywiste scenariusze.

Narzędzie w przejrzysty sposób prezentuje odpowiedzi, w tym kody stanu, nagłówki i ładunki, co umożliwia szybkie weryfikowanie działania interfejsu API i ułatwia rozwiązywanie problemów. To uporządkowane podejście przyspiesza cykl życia rozwoju, poprawia jakość interfejsu API i pogłębia zrozumienie możliwości i złożoności interfejsu Merchant API.

Przegląd

Aby używać kolekcji MAPI Postman w instancji Postman, musisz najpierw wykonać kilka czynności, aby skonfigurować środowisko. Oto szczegółowe instrukcje, jak to zrobić.

Więcej informacji o platformie znajdziesz w opisie Postmana.

1. Konfigurowanie konta usługi

Otrzymasz serviceAccountKey i api_key.

  1. Szczegółowe instrukcje znajdziesz w artykule Jak używać konta usługi do uzyskiwania dostępu do interfejsu API.
  2. W projekcie Google Cloud kliknij Dane logowania > Utwórz dane logowania > Konto usługi.
  3. Wypełnij formularz i kliknij Utwórz i kontynuuj.
  4. Wybierz rolę Właściciel i kliknij Dalej.
  5. Kliknij przycisk Gotowe.
  6. Aby pobrać klucz JSON, wykonaj te czynności:
    1. Kliknij utworzony adres e-mail konta usługi (np. {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com).
    2. Kliknij kartę Klucze.
    3. Kliknij Dodaj klucz > Utwórz klucz.
    4. Wybierz JSON i kliknij Utwórz, aby pobrać plik JSON.

OSTRZEŻENIE: klucz można pobrać tylko raz. Jeśli go utracisz, musisz utworzyć nowy klucz i usunąć ten.

  1. Otwórz Merchant Center.
  2. W sekcji Ustawienia > Dostęp i usługi kliknij Osoby i dostęp.
  3. Kliknij Dodaj osobę i użyj identyfikatora konta usługi jako adresu e-mail nowego użytkownika.

2. Konfigurowanie narzędzia Postman

  1. Pobierz plik JSON z szablonem środowiska Postman.
  2. Pobierz plik JSON kolekcji MAPI Postman.
  3. Zaloguj się w Postmanie lub utwórz nowe konto.
  4. Importowanie szablonu środowiska Postman
    1. Skopiuj pełny kod JSON i wklej go w sekcji Środowisko > Moje konto > serviceAccountKey.
    2. Skopiuj private_key z pliku JSON do kolekcji Environment > MyAccount > api_key.
  5. Importowanie pliku JSON kolekcji MAPI Postman
  6. Wybierz środowisko w prawym górnym rogu.

3. Rejestracja dewelopera

Połącz konto Merchant Center z projektem Google Cloud, rejestrując się jako programista. Użytkownicy z rolą programisty korzystającego z interfejsu API będą otrzymywać komunikaty dotyczące interfejsu API, w tym obowiązkowe powiadomienia, ankiety dla programistów i informacje o możliwościach.

  1. Otwórz Postman > Kolekcje > Oficjalny interfejs Merchant API.
  2. Otwórz accounts_v1 > accounts > accounts.developerRegistration > registerGcp.
  3. Zastąp symbol zastępczy {account} w ścieżce identyfikatorem MC.
  4. Zastąp obiekt zastępczy {email} w treści swoim adresem e-mail.
  5. Aby zarejestrować się w programie, kliknij Wyślij.
  6. Jeśli wszystko zostało wykonane prawidłowo, otrzymasz odpowiedź JSON z potwierdzeniem, np. taką: json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. Testowanie interfejsu Merchant API w Postmanie

  1. Otwórz Postman > Collections > Merchant API Official > accounts_v1 > accounts > list.
  2. Kliknij Wyślij.
  3. Jeśli wszystko zostało wykonane prawidłowo, otrzymasz odpowiedź JSON z potwierdzeniem, np. taką: json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }