پیش نیازها

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

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

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

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

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

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

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

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

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

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

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

Android Over The Air Dashboard را امتحان کنید

این مستندات API فرض می‌کند که از Android Over The Air Dashboard استفاده کرده‌اید، و با مفاهیم برنامه‌نویسی وب و قالب‌های داده‌های وب آشنا هستید.

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

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

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

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

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

اصطلاح REST مخفف " انتقال دولت نمایندگی " است. در زمینه Google API ها، به استفاده از افعال 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 در Android Over The Air API

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

فرمت های خاص برای URI های API Android Over The Air عبارتند از:

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

مجموعه کامل URI های مورد استفاده برای هر عملیات پشتیبانی شده در API در سند مرجع Android Over The Air API خلاصه شده است.

اصول JSON را یاد بگیرید

Android Over The Air API داده ها را در قالب JSON برمی گرداند.

JSON (JavaScript Object Notation) یک قالب داده رایج و مستقل از زبان است که نمایش متنی ساده ای از ساختارهای داده دلخواه را ارائه می دهد. برای اطلاعات بیشتر، به json.org مراجعه کنید.