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

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

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

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

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

הוספת הפרויקט לרשימת ההיתרים

Android Over The Air API זמין רק לפרויקטים ברשימת ההיתרים. אם הפרויקט לא נמצא ברשימת ההיתרים, יתקבלו 404 שגיאות בניסיון להשתמש בו.

על מנת להוסיף את הפרויקט שלכם לרשימת ההיתרים, עליכם לשלוח אימייל למנהל החשבון הטכני (TAM) ב-Google ולציין בו את מזהה הפרויקט החדש שלכם.

מזהה הפרויקט מופיע במרכז הבקרה של Cloud. מידע נוסף זמין במסמך העזרה הזה.

הערה: מומלץ שמזהה הפרויקט יהיה בפורמט {company}-gota-api-{number}

אחרי שמוסיפים את האפליקציה לרשימת ההיתרים, enable את Android Over The Air API לפרויקט ומעיינים בהוראות להרשאה כדי לקבל פרטים על הגישה.

הערה: רק מזהה הפרויקט שסיפקת יוכל להשתמש ב-Android Over The Air API. מומלץ מאוד ליצור חשבון שירות (כפי שמתואר בהרשאה) לצורך השימוש ב-API, ולא להשתמש בחשבונות אישיים.

רוצה לנסות את לוח הבקרה Android Over The Air?

תיעוד ה-API הזה מבוסס על ההנחה שכבר השתמשתם ב-Android Over The Air Dashboard ושאתם מכירים מושגים של תכנות אתרים ופורמטים של נתוני אינטרנט.

אם לא השתמשתם ב-Android Over The Air Dashboard, מומלץ לנסות את ממשק המשתמש לפני שמתחילים לתכנת.

העקרונות הבסיסיים של 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 ב-Android Over The Air API

הפעולות של Android Over The Air API ממופות ישירות לפעלים מסוג REST HTTP.

הפורמטים הספציפיים למזהי URI של Android Over The Air API הם:

https://www.googleapis.com/android/over-the-air/v1/resourcePath?parameters

הקבוצה המלאה של מזהי URI שמשמשים לכל פעולה נתמכת ב-API מסוכמת במסמך Android Over The Air API Reference.

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

ה-Android Over The Air API מחזיר נתונים בפורמט JSON.

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