בשיעור נלמד:

על ה- API של אוריגמי ואיך לעבוד מולו.

מה תדע/י לעשות בסוף השיעור:

איך לפנות ל- API של אוריגמי, ליצור רשומות, לעדכן ולמחוק אותן.

היי, ברוכים הבאים לאקדמיית אוריגמי.

בשיעור היום נעבור על דוקומנטציית ה- API שלנו באוריגמי וניתן דוגמאות לפעולות שניתן לעשות מולו, כדי לבצע פעולות מותאמות אישית לסביבה שלכם במידה ולא קיים פיצ’ר כזה בפלטפורמה עצמה.

את המידע המלא, ניתן למצוא בקישור למסמך המלא.

ראשית, כדי לקבל מידע על מבנה ישות באוריגמי או על רשימת הישויות, ניתן להשתמש בקריאה שלנו למבנה הישויות:

בנוסף, כדי לקבל מידע מרשומות ספציפיות, ניתן להשתמש בקריאה שלנו לשליפת מידע:

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

ניתן לעדכן שדות, רגילים או בקבוצה חוזרת, בתוך רשומה קיימת:

ניתן גם ליצור רשומה חדשה לגמרי:

בנוסף, אוריגמי מאפשרת להקפיץ התראות למשתמש, או לבצע את כלל הפעולות שציינו מעלה בישויות עם שדה לוח שנה.

לסיום, ניתן גם למחוק רשומות באמצעות ה- API:

שימו לב לכמה דגשים חשובים:

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