پیش‌نیازها

قبل از اینکه بتوانید کدنویسی اولین برنامه کلاینت خود را شروع کنید، چند کار وجود دارد که اگر قبلاً انجام نداده‌اید، باید انجام دهید.

یک پروژه برای مشتری خود ایجاد کنید

قبل از اینکه بتوانید درخواست ارسال کنید، باید به گوگل در مورد کلاینت خود اطلاع دهید و دسترسی به API را فعال کنید. شما این کار را با استفاده از کنسول API گوگل برای ایجاد یک پروژه ، که مجموعه‌ای نامگذاری شده از تنظیمات و اطلاعات دسترسی به API است، و ثبت درخواست خود انجام می‌دهید.

برای شروع استفاده از Android Over The Air API، ابتدا باید از ابزار راه‌اندازی استفاده کنید که شما را در ایجاد یک پروژه در کنسول Google API و فعال کردن API راهنمایی می‌کند.

پروژه را در لیست سفید قرار دهید

رابط برنامه‌نویسی کاربردی اندروید روی ایر (Android Over The Air API) فقط برای پروژه‌هایی که در لیست سفید قرار دارند در دسترس است. اگر پروژه شما در لیست سفید قرار نداشته باشد، هنگام تلاش برای استفاده از آن با خطای 404 مواجه خواهید شد.

برای قرار گرفتن در لیست سفید، یک ایمیل به Google TAM خود ارسال کنید تا شناسه پروژه جدید شما در لیست سفید قرار گیرد.

شناسه پروژه را می‌توانید در داشبورد ابری خود پیدا کنید. برای اطلاعات بیشتر به این سند راهنما مراجعه کنید.

توجه داشته باشید که شناسه پروژه در حالت ایده‌آل باید به این شکل باشد {company}-gota-api-{number}

بعد از اینکه در لیست سفید قرار گرفتید، Android Over The Air API را برای پروژه خود فعال کنید و برای جزئیات دسترسی به آن، به بخش نحوه‌ی مجوزدهی مراجعه کنید.

توجه داشته باشید که فقط شناسه پروژه‌ای که شما ارائه کرده‌اید قادر به استفاده از API اندروید از طریق هوا خواهد بود. اکیداً توصیه می‌کنیم به جای استفاده از حساب‌های شخصی، یک حساب کاربری سرویس (مطابق توضیحات در مجوز) برای استفاده از API ایجاد کنید.

داشبورد اندروید از طریق بی‌سیم را امتحان کنید

این مستندات API فرض می‌کند که شما از داشبورد اندروید روی هوا استفاده کرده‌اید و با مفاهیم برنامه‌نویسی وب و فرمت‌های داده وب آشنا هستید.

اگر از داشبورد اندروید روی ایر استفاده نکرده‌اید، قبل از شروع کدنویسی، رابط کاربری آن را امتحان کنید.

اصول اولیه REST را بیاموزید

دو روش برای فراخوانی API وجود دارد:

اگر تصمیم دارید از کتابخانه‌های کلاینت استفاده نکنید، باید اصول اولیه REST را درک کنید.

REST سبکی از معماری نرم‌افزار است که رویکردی مناسب و سازگار برای درخواست و تغییر داده‌ها ارائه می‌دهد.

اصطلاح REST مخفف عبارت « Representational State Transfer » است. در زمینه APIهای گوگل، به استفاده از افعال HTTP برای بازیابی و تغییر نمایش داده‌های ذخیره شده توسط گوگل اشاره دارد.

در یک سیستم RESTful، منابع در یک مخزن داده ذخیره می‌شوند؛ یک کلاینت درخواستی ارسال می‌کند که سرور یک عمل خاص (مانند ایجاد، بازیابی، به‌روزرسانی یا حذف یک منبع) را انجام دهد، و سرور عمل را انجام داده و پاسخی را ارسال می‌کند، که اغلب به شکل نمایشی از منبع مشخص شده است.

در APIهای RESTful گوگل، کلاینت با استفاده از یک فعل 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 در رابط برنامه‌نویسی کاربردی (API) اندروید از طریق بی‌سیم

عملیات‌های Android Over The Air API مستقیماً به افعال REST HTTP نگاشت می‌شوند.

قالب‌های خاص برای URI های API اندروید از طریق هوا عبارتند از:

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

مجموعه کامل URI های مورد استفاده برای هر عملیات پشتیبانی شده در API در سند مرجع API اندروید از طریق هوا خلاصه شده است.

اصول اولیه JSON را بیاموزید

رابط برنامه‌نویسی کاربردی اندروید (Android Over The Air API) داده‌ها را با فرمت JSON برمی‌گرداند.

JSON (نمادگذاری شیء جاوا اسکریپت) یک قالب داده رایج و مستقل از زبان است که نمایش متنی ساده‌ای از ساختارهای داده دلخواه را ارائه می‌دهد. برای اطلاعات بیشتر، به json.org مراجعه کنید.