FEATURES
cook

RESTful API – ממשק API מתקדם

פתח חשבון חינם

API הוא ממשק מערכת אקטיב טרייל לאינטגרציה בין מערכות. באמצעותו ניתן לעשות את כל מה שניתן לעשות במערכת הווב של אקטיב טרייל.

אקטיב טרייל עברה לעבוד בטכנולוגית RESTful API, ממשק API גמיש, אינטואיטיבי למשתמש וחדשני!

Active API documentation

תקשורת בין מכונות מעולם לא הייתה קלה יותר, באמצעות ממשק ה API תוכלו לקשר בין כמה מערכות שרק תרצו באופן מיידי וחכם. RESTful API הוא ממשק שכל מתכנת ירצה לעבוד איתו ובאמצעותו תוכלו לבנות קמפיינים מדויקים ויפים בדיוק כמו במערכת הווב של אקטיב טרייל.

איך משתמשים ב RESTful Api ?

כניסה באמצעות קוד גישה

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

על מנת להתחיל להשתמש בRest API, עליכם להתחבר למערכת אקטיב טרייל ולהיכנס לבתפריט העליון ל”עוד” > “אינטגרציות” > “אפליקציות Apps” <  “API”

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

על מנת ליצור קוד גישה, פשוט לחצו על ‘חדש’ ויופיע לכם המסך ליצירת קוד הגישה:

אפליקציית API

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

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

לאחר שתלחצו על ‘שמור’, קוד הגישה שיצרתם יופיע לכם ברשימה תחת ‘אפליקציות API’:

רשימת אפליקציות

Webhooks

משמאל ללשונית האפליקציות API , תוכלו למצוא את לשונית ה’אירועים’, אשר בדוקומנטציה של הAPI נקראים Webhooks.

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

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

על מנת לבדוק אם קיבלתם מאיתנו פנייה, לחצו על ‘שלח בדיקה’ ובדקו אצלכם האם התקבלה הפנייה.

אירועים

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

תיעוד מקוון

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

כל הפונקציות פתוחות לשימושכם, כולל מערכת האוטומציה שלנו.

הפונקציות מחולקות לקטיגוריות, בדיוק כמו במערכת הווב של אקטיב טרייל כל משימה שניתן לבצע בממשק המשתמש של אקטיב טרייל, ניתן לבצע ב-API:

Groups

לכל פונקציה במערכת יש כפתור TEST API שם הוא יכול לנסות את הפונקציה ולתפעל אותה.

Test API

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

זהו, עכשיו אתם מכירים את ממשק RESTful API, ממשק API מתקדם, חדשני ונוח לשימוש.

היכנסו לתיעוד וגשו לעבודה!

היכנסו כאן ל RESTful API

בחזרה לעמוד הקודם
הירשם לניוזלטר של אקטיב טרייל וקבל עדכונים, סיפורי הצלחה וטיפים

Please leave this field empty.