دستورالعمل‌های API Postman

Postman با ارائه یک رابط کاربرپسند برای ساخت، ارسال و تجزیه و تحلیل درخواست‌های HTTP، توانایی آزمایش و درک APIهای Merchant را به طور قابل توجهی افزایش می‌دهد. شما می‌توانید به راحتی فراخوانی‌های مختلف API (GET، POST، PUT، DELETE) را به نقاط انتهایی مختلف ایجاد و اصلاح کنید، پارامترها، هدرها و بدنه‌های درخواست را برای شبیه‌سازی سناریوهای دنیای واقعی تنظیم کنید.

ارائه واضح پاسخ‌ها، شامل کدهای وضعیت، هدرها و بارهای داده (payloads)، توسط این ابزار، امکان تأیید سریع رفتار API را فراهم می‌کند و به اشکال‌زدایی مشکلات کمک می‌کند. این رویکرد ساختاریافته، چرخه عمر توسعه را تسریع می‌کند، کیفیت API را بهبود می‌بخشد و درک قابلیت‌ها و پیچیدگی‌های API فروشنده را عمیق‌تر می‌کند.

نمای کلی

برای استفاده از مجموعه MAPI Postman در نمونه Postman خود، ابتدا باید چند مرحله را برای پیکربندی محیط دنبال کنید. در اینجا راهنمای گام به گام نحوه انجام این کار آمده است.

برای اطلاعات بیشتر در مورد پلتفرم، به توضیحات Postman مراجعه کنید.

۱. پیکربندی حساب کاربری سرویس

شما serviceAccountKey و api_key را دریافت خواهید کرد.

  1. برای مراحل دقیق‌تر ، نحوه استفاده از یک حساب کاربری سرویس برای دسترسی به API را دنبال کنید.
  2. در پروژه گوگل کلود خود > اعتبارنامه‌ها > ایجاد اعتبارنامه‌ها > حساب سرویس
  3. فرم را پر کنید و روی ایجاد و ادامه کلیک کنید
  4. مالک نقش را انتخاب کنید و روی ادامه کلیک کنید
  5. کلیک کنید انجام شد
  6. برای دانلود کلید JSON، مراحل زیر را دنبال کنید:
    1. روی ایمیل حساب سرویس که تازه ایجاد کرده‌اید کلیک کنید (چیزی شبیه {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com)
    2. روی تب کلیدها کلیک کنید
    3. روی افزودن کلید > ایجاد کلید کلیک کنید
    4. JSON را انتخاب کنید و برای دانلود JSON روی Create کلیک کنید.

هشدار: شما فقط یک بار می‌توانید کلید را دانلود کنید ، اگر آن را گم کنید، باید یک کلید جدید ایجاد کنید و این کلید را حذف کنید.

  1. مرکز تجاری باز
  2. در تنظیمات > دسترسی و سرویس، روی افراد و دسترسی کلیک کنید.
  3. روی افزودن شخص کلیک کنید و از شناسه حساب سرویس به عنوان آدرس ایمیل برای کاربر جدید استفاده کنید.

۲. راه‌اندازی پستچی

  1. دانلود قالب JSON محیط Postman
  2. دانلود مجموعه JSON از MAPI Postman
  3. وارد پستچی شوید یا یک حساب کاربری جدید ایجاد کنید
  4. وارد کردن الگوی محیط Postman
    1. فایل JSON کامل خود را در مسیر Environment > MyAccount > serviceAccountKey کپی کنید.
    2. private_key خود را از JSON به Environment > MyAccount > api_key در مجموعه کپی کنید.
  5. وارد کردن مجموعه JSON از MAPI Postman
  6. محیط را در گوشه بالا سمت راست انتخاب کنید

۳. ثبت نام توسعه‌دهنده

با ثبت نام به عنوان توسعه دهنده، حساب مرکز فروشندگان خود را به پروژه Google Cloud متصل کنید. کاربرانی که نقش توسعه دهنده API را دارند، ارتباطات API، از جمله اطلاعیه‌های اجباری خدمات، نظرسنجی‌های توسعه دهندگان و فرصت‌ها را دریافت خواهند کرد.

  1. پستچی باز > مجموعه‌ها > رابط برنامه‌نویسی کاربردی فروشگاه رسمی
  2. باز کردن accounts_v1 > accounts > accounts.developerRegistration > registerGcp
  3. به جای {account} در مسیر، شناسه MC خود را وارد کنید.
  4. به جای {email} در بدنه، آدرس ایمیل خود را قرار دهید.
  5. برای ثبت نام روی ارسال کلیک کنید
  6. اگر همه چیز به درستی انجام شده باشد، یک پاسخ JSON تأیید مانند این دریافت خواهید کرد: json { "name": "accounts/{YOUR_MC_ID}/developerRegistration", "gcpIds": [ "{YOUR_GCP_ID}" ] }

۴. تست API فروشنده روی Postman

  1. پستچی را باز کنید > مجموعه‌ها > رابط برنامه‌نویسی کاربردی پذیرنده > حساب‌های_نسخه ۱ > حساب‌ها > لیست
  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" } ] }