Pedoman Postman API

Postman secara signifikan meningkatkan kemampuan untuk menguji dan memahami Merchant API dengan menyediakan antarmuka yang mudah digunakan untuk membuat, mengirim, dan menganalisis permintaan HTTP. Anda dapat dengan mudah membuat dan mengubah berbagai panggilan API (GET, POST, PUT, DELETE) ke berbagai endpoint, menyesuaikan parameter, header, dan isi permintaan untuk menyimulasikan skenario dunia nyata.

Presentasi respons yang jelas dari alat ini, termasuk kode status, header, dan payload, memungkinkan verifikasi cepat perilaku API dan membantu men-debug masalah. Pendekatan terstruktur ini mempercepat siklus proses pengembangan, meningkatkan kualitas API, dan memperdalam pemahaman tentang kemampuan dan kerumitan Merchant API.

Ringkasan

Untuk menggunakan koleksi MAPI Postman di instance Postman, Anda harus mengikuti beberapa langkah untuk mengonfigurasi lingkungan terlebih dahulu. Berikut panduan langkah demi langkah tentang cara melakukannya.

Untuk mengetahui informasi selengkapnya tentang platform, lihat deskripsi Postman.

1. Konfigurasi Akun Layanan

Anda akan mendapatkan serviceAccountKey dan api_key

  1. Untuk langkah-langkah mendetail, ikuti cara menggunakan akun layanan untuk mengakses API
  2. Di Project Google Cloud > Credentials > Create credentials > Service account
  3. Isi formulir, lalu klik Buat dan lanjutkan
  4. Pilih peran Pemilik, lalu klik Lanjutkan.
  5. Klik Selesai
  6. Untuk mendownload kunci JSON, ikuti langkah-langkah berikut:
    1. Klik email Akun layanan yang baru saja dibuat (seperti {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com)
    2. Klik tab Keys
    3. Klik Add key > Create key
    4. Pilih JSON, lalu klik Create untuk mendownload JSON

PERINGATAN: Anda hanya dapat mendownload kunci satu kali. Jika Anda kehilangan kunci tersebut, Anda harus membuat kunci baru dan menghapus kunci ini

  1. Buka Merchant Center
  2. Di Setelan > Akses dan layanan, klik Orang dan akses
  3. Klik Tambahkan orang dan gunakan ID akun layanan sebagai alamat email untuk pengguna baru.

2. Penyiapan Postman

  1. Download JSON template Lingkungan Postman
  2. Download JSON koleksi MAPI Postman
  3. Login ke Postman atau buat akun baru
  4. Impor template Lingkungan Postman
    1. Salin JSON lengkap Anda ke Environment > MyAccount > serviceAccountKey
    2. Salin private_key Anda dari JSON ke Environment > MyAccount > api_key koleksi
  5. Mengimpor JSON Kumpulan Postman MAPI
  6. Pilih lingkungan di pojok kanan atas

3. Pendaftaran developer

Tautkan akun Merchant Center Anda ke project Google Cloud dengan mendaftar sebagai developer. Pengguna dengan peran developer API akan menerima komunikasi API, termasuk email pengumuman layanan, survei developer, dan peluang.

  1. Buka Postman > Collections > Merchant API Official
  2. Buka accounts_v1 > accounts > accounts.developerRegistration > registerGcp
  3. Ganti placeholder {account} di jalur dengan ID MC Anda
  4. Ganti placeholder {email} di isi email dengan alamat email Anda
  5. Klik Kirim untuk menjalankan pendaftaran
  6. Jika semuanya telah dilakukan dengan benar, Anda akan menerima respons JSON konfirmasi seperti ini: json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. Menguji Merchant API di Postman

  1. Buka Postman > Collections > Merchant API Official > accounts_v1 > accounts > list
  2. Klik Kirim
  3. Jika semuanya telah dilakukan dengan benar, Anda akan menerima respons JSON konfirmasi seperti ini: json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }