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

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

קבל חשבון Google

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

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

התנסות ב-Google Street View

מאמרי העזרה של ה-API מתבססים על ההנחה שכבר השתמשתם ב-Google Street View ושאתם מכירים את מושגי התכנות באינטרנט ואת הפורמטים של נתוני האתרים.

אם לא השתמשתם ב-Google Street View, נסו את ממשק המשתמש לפני שתתחילו לתכנת.

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

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

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

אם עדיין לא עשית זאת, עליך ליצור את מפתח ה-API לאפליקציה שלך על ידי לחיצה על יוצרים פרטי כניסה > מפתח API. בשלב הבא מחפשים את מפתח ה-API ב-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 Street View Publish API

הפעולות של Google Street View Publish API ממופות ישירות לפעלים מסוג REST HTTP.

אלה הם הפורמטים שספציפיים למזהי URI של Google Street View Publish API:

https://www.googleapis.com/streetviewpublish/v1/resourcePath?parameters

הקבוצה המלאה של מזהי URI שמשמשים לכל פעולה נתמכת ב-API מסוכמת במסמך Google Street View Publish API.

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

Google Street View Publish API מחזיר נתונים בפורמט JSON.

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