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

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

קבל חשבון Google

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

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

יצירת פרויקט ללקוח

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

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

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

העקרונות הבסיסיים של 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.