הקדמה

ה-API שלנו מבוסס על בקשת פוסט פשוטה לכתובת:
https://api.superget.co.il

כל בקשה צריכה להכיל לפחות שני פרמטרים בסיסים:
action: שם הפונקציה שאליה ברצונך לפנות. את רשימת הפונקציות המלאה ניתן לראות כאן.
api_key: מפתח API ייחודי שבו משתמשת המערכת על מנת לזהות אותך. את מפתח ה- API תוכל לקבל על ידי התחברות לפאנל הניהול ובחירה מתוך תפריט הצד ב-"מפתחות API".

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

שלום עולם

הדוגמה הראשונה לעבודה עם ה-API של SuperGET תהיה קריאה לפונקציה TestFunction. הפונקציה הזאת היא פונקציה לבדיקת התחברות ראשונה עם ה-API, במידה והכל יעבוד כשורה, תקבל בחזרה אובייקט JSON בשם success עם הערך Hello World.
דוגמה לפעילות תקינה תוכל לראות בעמוד הזה של כלי הבדיקות שלנו.

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

function send_post_to_url($url,$post) {
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($ch,CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
    $return = curl_exec($ch);
    curl_close($ch);
    return $return;
}
 
$data['api_key'] = YOUR_API_KEY;
$data['action'] = 'TestFunction';
$response = send_post_to_url('https://api.superget.co.il/',$data);
echo $response;

הקוד הוא למעשה בקשת POST שמכילה שני פרמטרים:
action: פנייה לפונקציה TestFunction.
api_key: מפתח ה-API הייחודי לך.

קבלת כל הסופרמרקטים הקיימים לפי עיר

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

function send_post_to_url($url,$post) {
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($ch,CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
    $return = curl_exec($ch);
    curl_close($ch);
    return $return;
}
 
$api_key = YOUR_API_KEY;
$data['api_key'] = $api_key;
$data['action'] = 'GetCityByName';
$data['city_name'] = 'נתניה';
$response = send_post_to_url('https://api.superget.co.il/', $data);
$obj = json_decode($response);
$city_id = $obj[0]->city_id;

בשלב הזה יצרנו משתנה בשם city_id שמכיל את ה-ID של העיר נתניה. את המשתנה הזה אנחנו נעביר לפונקציה נוספת בשם GetStoresByCityID, על מנת להשיג את כל החנויות שנמצאות תחת אותו ה-ID שקיים במשתנה. והקוד המלא:

function send_post_to_url($url,$post) {
    $ch = curl_init($url);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
    curl_setopt($ch,CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($post));
    $return = curl_exec($ch);
    curl_close($ch);
    return $return;
}
 
$api_key = YOUR_API_KEY;
$data['api_key'] = $api_key;
$data['action'] = 'GetCityByName';
$data['city_name'] = 'נתניה';
$response = send_post_to_url('https://api.superget.co.il/', $data);
$obj = json_decode($response);
$city_id = $obj[0]->city_id;
 
$data2['api_key'] = $api_key;
$data2['action'] = 'GetStoresByCityID';
$data2['city_id'] = $city_id;
$response2 = send_post_to_url('https://api.superget.co.il/', $data2);
echo $response2;