הנחיות לשימוש ב-API Postman

‫Postman משפר באופן משמעותי את היכולת לבדוק ולהבין את Merchant APIs, כי הוא מספק ממשק ידידותי למשתמש ליצירה, לשליחה ולניתוח של בקשות HTTP. אתם יכולים ליצור ולשנות בקלות קריאות שונות ל-API (GET,‏ POST,‏ PUT,‏ DELETE) לנקודות קצה שונות, ולשנות פרמטרים, כותרות וגופי בקשות כדי לדמות תרחישים מהעולם האמיתי.

הכלי מציג את התגובות בצורה ברורה, כולל קודי סטטוס, כותרות ומטענים ייעודיים (payloads), וכך מאפשר לאמת במהירות את התנהגות ה-API ולעזור בניפוי באגים בבעיות. הגישה המובנית הזו מקצרת את מחזור החיים של הפיתוח, משפרת את איכות ה-API ומעמיקה את ההבנה של היכולות והמורכבויות של Merchant API.

סקירה כללית

כדי להשתמש באוסף MAPI Postman במופע Postman שלכם, צריך לבצע כמה שלבים כדי להגדיר את הסביבה קודם. כאן מפורטים השלבים לביצוע הפעולה.

מידע נוסף על הפלטפורמה זמין בתיאור של Postman.

1. הגדרת חשבון שירות

יוצגו לכם serviceAccountKey ו-api_key.

1. הוראות מפורטות זמינות במאמר איך משתמשים בחשבון שירות כדי לגשת ל-API
2. בפרויקט Google Cloud > Credentials (פרטי כניסה) > Create credentials (יצירת פרטי כניסה) > Service account (חשבון שירות)
3. ממלאים את הטופס ולוחצים על יצירה והמשך.
4. בוחרים בתפקיד בעלים ולוחצים על המשך.
5. לוחצים על סיום
6. כדי להוריד את מפתח ה-JSON:
   1. לוחצים על כתובת האימייל של חשבון השירות שנוצר (למשל, {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com).
   2. לוחצים על הכרטיסייה Keys (מפתחות).
   3. לוחצים על Add key (הוספת מפתח) > Create key (יצירת מפתח).
   4. בוחרים באפשרות JSON ולוחצים על Create כדי להוריד את קובץ ה-JSON.

אזהרה: אפשר להוריד את המפתח רק פעם אחת. אם מאבדים אותו, צריך ליצור מפתח חדש ולמחוק את המפתח הזה.

1. פותחים את Merchant Center.
2. בקטע הגדרות > גישה ושירותים לוחצים על משתמשים והרשאות גישה.
3. לוחצים על הוספת משתמש ומשתמשים במזהה של חשבון השירות ככתובת האימייל של המשתמש החדש.

2. הגדרה של Postman

1. הורדת קובץ ה-JSON של תבנית סביבת Postman
2. הורדת קובץ JSON של אוסף MAPI Postman
3. נכנסים ל-Postman או יוצרים חשבון חדש.
4. ייבוא תבנית של סביבת Postman
   1. מעתיקים את ה-JSON המלא אל Environment (סביבה) > MyAccount (החשבון שלי) > serviceAccountKey (מפתח חשבון שירות).
   2. מעתיקים את private_key מה-JSON אל Environment > MyAccount > api_key באוסף.
5. ייבוא קובץ JSON של אוסף MAPI Postman
6. בוחרים את הסביבה בפינה השמאלית העליונה.

3. הרשמה כמפתח

כדי לקשר בין חשבון Merchant Center לבין פרויקט Google Cloud, צריך להירשם כמפתח. המשתמשים עם תפקיד מפתח ה-API יקבלו הודעות שקשורות ל-API, כולל עדכונים חיוניים בנוגע לשירות, סקרים שמכוונים למפתחים והודעות על הזדמנויות.

1. פותחים את Postman > Collections > Merchant API Official.
2. פותחים את accounts_v1 > accounts > accounts.developerRegistration > registerGcp
3. מחליפים את ה-placeholder {account} בנתיב במזהה החשבון שלכם ב-Merchant Center.
4. מחליפים את ה-placeholder ‏{email} בגוף ההודעה בכתובת האימייל שלכם.
5. לוחצים על שליחה כדי לבצע את הרישום.
6. אם הכל בוצע בצורה נכונה, תקבלו תגובת JSON לאישור, כמו זו: json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

4. בדיקת Merchant API ב-Postman

1. פותחים את Postman > Collections > Merchant API Official > accounts_v1 > accounts > list
2. לוחצים על שליחה.
3. אם הכל בוצע בצורה נכונה, תקבלו תגובת JSON לאישור, כמו זו: json { "accounts": [ { "name": "accounts/{YOUR_MC_ID}", "accountId": "{YOUR_MC_ID}", "accountName": "{YOUR_MERCHANT_NAME}", "adultContent": false, "timeZone": { "id": "{YOUR_TIMEZONE}" }, "languageCode": "en-US" } ] }