إرشادات Postman API

يحسّن Postman بشكل كبير القدرة على اختبار وفهم واجهات Merchant API من خلال توفير واجهة سهلة الاستخدام لإنشاء طلبات HTTP وإرسالها وتحليلها. يمكنك بسهولة إنشاء وتعديل طلبات مختلفة لواجهة برمجة التطبيقات (GET وPOST وPUT وDELETE) إلى نقاط نهاية مختلفة، وتعديل المَعلمات والعناوين الرئيسية ونص الطلب لمحاكاة سيناريوهات واقعية.

يساعد العرض الواضح للردود الذي توفّره الأداة، بما في ذلك رموز الحالة والعناوين والحمولات، في التحقّق السريع من سلوك واجهة برمجة التطبيقات ويساعد في تصحيح الأخطاء. تؤدي هذه الطريقة المنظَّمة إلى تسريع عملية التطوير وتحسين جودة واجهة برمجة التطبيقات وتعزيز فهم إمكانات واجهة Merchant API وتفاصيلها.

نظرة عامة

لاستخدام مجموعة MAPI Postman على مثيل Postman، عليك اتّباع بضع خطوات لضبط البيئة أولاً. في ما يلي إرشادات مفصّلة حول كيفية إجراء ذلك.

لمزيد من المعلومات حول المنصة، يُرجى الاطّلاع على وصف Postman.

1. ضبط حساب الخدمة

ستحصل على serviceAccountKey وapi_key

1. للاطّلاع على الخطوات التفصيلية، يُرجى اتّباع كيفية استخدام حساب خدمة للوصول إلى واجهة برمجة التطبيقات.
2. في مشروع Google Cloud > بيانات الاعتماد > إنشاء بيانات اعتماد > حساب خدمة
3. املأ النموذج وانقر على إنشاء ومتابعة.
4. اختَر الدور المالك وانقر على متابعة.
5. 3. انقر على تم.
6. لتنزيل مفتاح JSON، اتّبِع الخطوات التالية:
   1. انقر على عنوان البريد الإلكتروني لحساب الخدمة الذي تم إنشاؤه للتو (مثل {YOUR_SERVICE_ACCOUNT}@{RANDOM_DOMAIN}.gserviceaccount.com).
   2. انقر على علامة التبويب المفاتيح.
   3. انقر على إضافة مفتاح > إنشاء مفتاح
   4. اختَر JSON وانقر على إنشاء لتنزيل JSON.

تحذير: يمكنك تنزيل المفتاح مرة واحدة فقط، وإذا فقدته، عليك إنشاء مفتاح جديد وحذف هذا المفتاح.

1. افتح Merchant Center.
2. في الإعدادات > الوصول والخدمة، انقر على المستخدمون وأذونات الوصول.
3. انقر على إضافة مستخدم واستخدِم معرّف حساب الخدمة كعنوان بريد إلكتروني للمستخدم الجديد.

2. إعداد Postman

1. تنزيل نموذج JSON لبيئة Postman
2. نزِّل ملف JSON الخاص بمجموعة MAPI Postman.
3. تسجيل الدخول إلى Postman أو إنشاء حساب جديد
4. استيراد نموذج بيئة Postman
   1. انسخ كائن JSON الكامل إلى البيئة > حسابي > serviceAccountKey.
   2. انسخ private_key من ملف JSON إلى البيئة في المجموعة > حسابي > api_key.
5. استيراد ملف JSON لمجموعة MAPI Postman
6. اختَر البيئة في أعلى يسار الصفحة

3- تسجيل المطوّر

اربط حسابك على Merchant Center بمشروع Google Cloud من خلال التسجيل كمطوّر. سيتلقّى المستخدمون الذين لديهم دور مطوّر واجهة برمجة التطبيقات الرسائل المتعلقة بواجهة برمجة التطبيقات، بما في ذلك الإشعارات الإلزامية عن الخدمة والاستطلاعات المخصصة للمطوّرين والفرص المتاحة لهم.

1. افتح Postman > المجموعات > Merchant API Official
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}" ] }

4. اختبار Merchant API على Postman

1. افتح Postman > المجموعات > 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" } ] }