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

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

קבל חשבון Google

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

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

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

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

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

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

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

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

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

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

המונח REST הוא קיצור של Representational State Transfer. בהקשר של ממשקי ה-API של Google,‏ 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

הפעולות של ממשק ה-API של חיפוש הידע ב-Google Knowledge ממופות ישירות לפעלים של HTTP ב-REST.

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

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

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

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

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

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