דרישות מוקדמות

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

קבל חשבון Google

כדי ליצור פרויקט ב-Google API Console, צריך חשבון Google. אם כבר יש לכם חשבון, הכול מוכן.

יכול להיות שתרצו גם חשבון Google נפרד למטרות בדיקה.

יצירת פרויקט עבור הלקוח

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

כדי להתחיל להשתמש ב-Google Knowledge Graph Search API, צריך קודם להשתמש בכלי ההגדרה, שמדריך אתכם בתהליך של יצירת פרויקט ב-Google API Console והפעלת ה-API.

אם עדיין לא עשיתם זאת, לוחצים על Create credentials > API key כדי ליצור מפתח API לאפליקציה. בקטע API keys, מאתרים את מפתח ה-API.

העקרונות הבסיסיים של REST

יש שתי דרכים להפעיל את ה-API:

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

‫‏REST הוא סגנון של ארכיטקטורת תוכנה שמאפשר גישה נוחה ועקבית לשליחת בקשות ולשינוי של נתונים.

המונח REST הוא קיצור של Representational State Transfer. בהקשר של Google APIs,‏ REST מתייחס לשימוש בפעלים של HTTP כדי לאחזר ולשנות ייצוגים של נתונים ש-Google מאחסנת.

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

בממשקי RESTful API של Google, הלקוח מציין פעולה באמצעות פועל של HTTP כמו POST,‏ GET,‏ PUT או DELETE. הוא מציין משאב לפי URI ייחודי גלובלי, באופן הבא:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

בגלל שלכל משאבי ה-API יש מזהה URI ייחודי שניתן לגשת אליו באמצעות HTTP,‏ ב-REST אפשר לשמור נתונים במטמון והוא מותאם לעבודה עם התשתית המבוזרת של האינטרנט.

תוכלו להיעזר בהגדרות השיטה במסמכי התיעוד של תקני HTTP 1.1 – הן כוללות מפרטים של GET,‏ POST,‏ PUT ו-DELETE.

‫REST ב-Google Knowledge Graph Search API

הפעולות של Google Knowledge Graph Search API ממופות ישירות לפעלים מסוג REST HTTP.

אלה הם הפורמטים שספציפיים למזהי URI של Google Knowledge Graph Search API:

https://kgsearch.googleapis.com/v1/entities:search?query=your_query&parameters

הקבוצה המלאה של מזהי URI שמשמשים לכל פעולה נתמכת ב-API מסוכמת במסמך Google Knowledge Graph Search API Reference.

העקרונות הבסיסיים של JSON

ה-Google Knowledge Graph Search API מחזיר נתונים בפורמט JSON.

‫JSON‏ (JavaScript Object Notation) הוא פורמט נתונים נפוץ בלתי תלוי בשפה, שמספק ייצוג טקסט פשוט של מבני נתונים שרירותיים. למידע נוסף היכנסו לאתר של json.org.