API EXPLORER

כלי הAPI EXPLORER נועד כדי לוודא שפקודת API נכתבה כראוי. 

הכלי עוזר לאתר טעויות אם יש כאלה בכך שהפלט יכלול את סטטוס הקריאה (האם תקין או לא).

מפתחים יכולים להשתמש בכלי עבור בדיקת כל אחת מהפקודות הבאות: Create, Update, Query, Delete, Get.

כדי להגיע לממשק הAPI EXPLORER, יש להיכנס דרך המערכת לממשקי אינטרנט ע"י לחיצה על גלגל השיניים האפור מצד שמאל > ממשקי אינטרנט.

לאחר מכן, יש ללחוץ על ממשק Rest API. בתיבה שתיפתח לפנינו, יש ללחוץ על כפתור הAPI EXPLORER.

 

כניסה לממשקי אינטרנט דרך הגדרות מערכת

 

במסך המתקבל לפנינו, יש לבחור בפקודה הרלוונטית. הטוקן שיופיע באופן אוטומטי הינו הטוקן של המשתמש המחובר למערכת. 

השדות שיש למלא לטובת בניית הURL משתנים לפני סוג הפקודה שבחרנו. 

 

בחירת פעולה GET

 

להלן דוגמאות נפוצות לשימוש בכלי הAPI EXPLORER

GET

יש לבחור את שם האוביקט המתאים ומיד אחריו, להעתיק את הobjectid.  

העתקת objectid

 

עם לחיצה על כפתור בצע, יתקבל הפלט. סטטוס הפלט יכול להיות 200 (תקין) או כל שגיאה אחרת שיכולה לנבוע מכתיבה לא נכונה של תוכן הפקודה ולפיכך, קיימת טעות.

 

קטע קוד

 

הודעה

 

CREATE

 

פעולה CREATE

 

הודעת מערכת לאישור ביצוע השינויים

 

קטע קוד

 

UPDATE

 

פעולת UPDATE

 

תוצאה

 

DELETE

 

פעולת DELETE

 

הודעת מערכת לאישור ביצוע השינויים

 

תוצאה

 

QUERY

 

פעולת QUERY

 

תוצאה

 

לקריאת מאמרים בנושא API, לחצו כאן.