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

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

קבל חשבון Google

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

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

רוצה לנסות את Google Street View?

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

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

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

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

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

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

מידע בסיסי על REST

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

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

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

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

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

בממשקי ה-API של RESTful של 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 ישירות לפעלים מסוג HTTP ב-REST.

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

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.