מדריך הגישה לממשק RESTful API של מערכת אקטיב טרייל

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

API post

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

איך נכנסים ל RESTful API?

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

api flow

תחת כרטיסיית "אפליקציות API" תוכלו לייצר קוד גישה באמצעותו תתחברו למערכת אקטיב טרייל. כך תקשרו בין המערכת למערכות אחרות.

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

API חדש

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

לקוד גישה ניתן להגדיר גם כתובות IP מורשות, או טווח של כתובות IP מורשות.

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

אפליקציות API

 Webhooks

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

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

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

'הוסף פרמטרים' – הוסיפו פרמטרים לפי הAPI שלכם שיישלחו בכל פנייה לAPI שלכם.

'שלח בדיקה' – שלחו בדיקה על על מנת לבדוק אם קיבלתם מאיתנו פנייה.

אירועים

יש לנו 2 אירועים בהם נפעיל את ה WEBHOOK ונפנה ל-API שלכם, על מנת לעדכן אותם עדכנו במקום המתאים את כתובת ה- URL של הAPI שלכם.

  1. שינוי נמען – כאשר נעשה שינוי בפרטי נמען שלא כתוצאה משינוי ידני בממשק אקטיב טרייל, אלא כתוצאה של עדכון חיצוני (דרך טופס הרשמה, דרך עדכון API, דרך דף נחיתה או בכל דרך אחרת שהיא לא ידנית).
  2. שינוי ידני –כאשר מעדכנים באופן ידני את פרטי הנרשם במערכת הווב של אקטיב טרייל.

גישה באמצעות תיעוד מקוון

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

Active API documentation

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

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