Skip to content

Postman collection#

כדי לבדוק וניפוי באגים בבקשות ל-Green API, אתה יכול להשתמש the API section in console אוֹ the Postman collection.

Postman - כלי נרחב לבדיקות ופיתוח API. כדי להקל על מפתחים להשתלב ב-Green API, יצרנו אוסף Postman עם סט שלם של API נדרש.

  1. Setup: הגדרת אוסף
  2. Configure: הגדרת סביבה
  3. Test: שימוש בשיטות API

הדרכה וידאו#

Setup#

כדי להתחיל, הורד את הרכיבים למטה והתקן את Postman:

לאחר התקנת והפעלת Postman, לחץ על 'ייבוא' ובחר בשני קבצי ה-JSON 'collection.json' ו-'environment.json' מתוך הקובץ Postman collection on GitHub.

Step 1

Step 2

לאחר הייבוא, תראה פריט Green API'' בקטעאוספים'' ותוכל לבחור Green API Developer'' בתורEnvironment''.

Configure#

סביבת Postman מותאמת אישית היא למעשה אוסף של זוגות "מפתח-ערך". אתה יכול ליצור משתנים סטנדרטיים שישמשו לאחר מכן בבקשות שונות. עוד על Postman environment variables.

סביבת Green API Developer המוגדרת מראש מכילה את סט המשתנים המלא, שאליהם מתייחס האוסף. יש לערוך חלק מהמשתנים הללו ולהחליף אותם בערכי לקוחות. כדי לפתוח את תיבת הדו-שיח של העריכה, לחץ על לחצן העין הקטנה שליד התפריט הנפתח של הסביבה ובחר 'ערוך'.

הגדר ערכים של ארבעת המשתנים apiUrl, mediaUrl, idInstanceוapiTokenInstance, אשר התקבלו ב- לפני שמתחילים שָׁלָב.

Test#

כעת תוכל לבחור כל שיטת API באוסף ולהתחיל לשלוח בקשות. מטעמי נוחות, כל השיטות מפורטות באותו סדר שבו הן נבדקות API documents.אתה יכול לבצע כל שינוי בשיטות אלה כדי להקל על בדיקתן ועיבוד התגובות.