ממשקי API של איוונטאקט: חיבור מערכות וקבלת נתוני אירועים

12 בספטמבר 2023 | 7 דקות קריאה

מהו API?

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

ממשקי API לאירועים

ממשקי Eventact API כוללים את החלקים העיקריים הבאים:

• Office — אוסף ממשקי API לביצוע Login, לניהול חשבון ולניהול פרויקטים.
• Registration API — אוסף נקודות קצה לניהול ההרשמה לאירוע.
• Abstracts API — אוסף נקודות קצה לניהול תוכניות אירועים ותקצירי הרצאות.

גישה לממשקי Eventact API: קבלת טוקן

כדי להשתמש בממשקי Office, Registration או Abstracts, נדרש טוקן.

לקבלת טוקן, יש לקרוא לממשק Login של ה־API בשם office.

להלן השלבים לקבלת טוקן API:

שלב 1: הכנת פרטי ההזדהות

לפני בקשת טוקן, ודאו שברשותכם פרטי ההזדהות הבאים, שתקבלו מאיוונטאקט:

• Username: שם המשתמש הייחודי שלכם באיוונטאקט.
• Password: הסיסמה המשויכת לחשבון איוונטאקט שלכם.
• Company Name: שם החברה או הארגון שלכם.

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

שלב 2: שליחת בקשת POST

כעת אפשר לשלוח בקשת POST ל־Eventact API בנקודת הקצה https://api.eventact.com/api-v1/office/login/login, ולכלול אובייקט JSON כדוגמת זה:

{
   "username": "YOUR_USERNAME",
   "password": "YOUR_PASSWORD",
   "companyname": "YOUR_COMPANY_NAME"
}

יש להמיר את האובייקט למחרוזת (stringified) בגוף הבקשה.

להלן דוגמה להגדרת פונקציה כזאת ב־React:

function GetToken() {
    const fetchData = async () => {
        try {
            const requestData = {
                username: 'YOUR_USERNAME',
                password: 'YOUR_PASSWORD',
                companyname: 'YOUR_COMPANY_NAME',
            };

            const response = await fetch('https://api.eventact.com/api-v1/office/login/login', {
                method: 'POST',
                headers: {
                'Content-Type': 'application/json',
                },
                body: JSON.stringify(requestData),
            });

            if (response.ok) {
                const data = await response.json();
            } else {
                console.error('Error fetching data');
            }
        } catch (error) {
            console.error('Error:', error);
        }
    };

    fetchData();
}

נתוני התגובה יהיו במבנה הבא:

{  
 "companyName": "YOUR_COMPANY_NAME",
 "companyID": 0, 
 "key": "REPLACE_WITH_API_TOKEN" 
}

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

let token=data.key

שלב 3: גישה ל־API של איוונטאקט לקבלת מידע על האירוע

איוונטאקט מציעה מגוון ממשקי API המותאמים לצרכים שונים. לקבלת הרשימה המלאה של הממשקים הזמינים והתיעוד המפורט שלהם, פנו אלינו עם בקשתכם. בהתאם לתיעוד, אפשר לשלוף נתונים באמצעות שינוי המזהים של תוכנית, אולם, אירוע או פריטים אחרים בנקודת הקצה של ה־API. נוסף על כך, אפשר להוסיף פרמטרים לשאילתה לאחר הסימן ? בסוף נקודת הקצה, למשל בפורמט ?fromDate={timestamp}, כדי לסנן ולהתאים את הנתונים המתקבלים.

לשם כך יש לשלוח בקשת HTTP GET לנקודת הקצה המתאימה של Eventact API, שמבנה הכתובת שלה יהיה דומה לזה: https://api.eventact.com/api-v1/agenda/${projectID}/agendas/list.

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

headers: {
    'API-token': token
    }  

לנוחותכם, להלן פונקציה לדוגמה בשם GetAgendasList, שמרכזת את בקשת ה־API הזאת:

function GetAgendasList(projectID, token) {
    const apiUrl = `https://api.eventact.com/api-v1/agenda/${projectID}/agendas/list`;

    return fetch(apiUrl, {
        method: 'GET',
        headers: {
            'API-token': token,
        },
    })
        .then((response) => {
            if (!response.ok) {
                throw new Error('Network response was not ok');
            }
            return response.json();
    })
        .then((data) => {
            return data;
    })
        .catch((error) => {
            console.error('Fetch error:', error);
            throw error;
        });
}

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

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