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

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

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

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

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

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

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

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

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

לתשומת ליבכם: רצוי שמזהה הפרויקט יהיה בפורמט הבא: {company}-gota-api-{number}

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

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

כדאי לנסות את מרכז הבקרה של Android דרך Air

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

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

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

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

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

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