قبل از اینکه بتوانید اولین برنامه مشتری خود را کدنویسی کنید، اگر قبلاً آنها را انجام نداده اید، باید چند کار را انجام دهید.
یک حساب Google دریافت کنید
برای ایجاد پروژه در Google API Console به یک حساب Google نیاز دارید. اگر قبلاً یک حساب کاربری دارید، پس همه چیز آماده است.
همچنین ممکن است یک حساب Google جداگانه برای اهداف آزمایشی بخواهید.
یک پروژه برای مشتری خود ایجاد کنید
قبل از ارسال درخواست به Google Knowledge Graph Search API، باید به Google در مورد مشتری خود بگویید و دسترسی به API را فعال کنید. این کار را با استفاده از Google API Console برای ایجاد یک پروژه ، که مجموعه ای نامگذاری شده از تنظیمات و اطلاعات دسترسی API است، انجام می دهید و برنامه خود را ثبت می کنید.
برای شروع استفاده از Google Knowledge Graph Search API، ابتدا باید از ابزار راهاندازی استفاده کنید که شما را از طریق ایجاد پروژه در Google API Console، فعال کردن API و ایجاد اعتبارنامه راهنمایی میکند.
اگر قبلاً این کار را نکردهاید، کلید API برنامه خود را با کلیک کردن روی ایجاد اعتبار > کلید API ایجاد کنید. در مرحله بعد، کلید API خود را در بخش کلیدهای API جستجو کنید.
اصول REST را بیاموزید
دو راه برای فراخوانی API وجود دارد:
- ارسال درخواست های HTTP و تجزیه پاسخ ها.
- استفاده از کتابخانه های مشتری
اگر تصمیم دارید از کتابخانه های مشتری استفاده نکنید، باید اصول 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 در Google Knowledge Graph Search API
عملیات API جستجوی نمودار دانش Google به طور مستقیم به افعال HTTP REST نگاشت می شود.
فرمت های خاص برای URI های API جستجوی نمودار دانش Google عبارتند از:
https://kgsearch.googleapis.com/v1/entities:search?query=your_query¶meters
مجموعه کامل URI های مورد استفاده برای هر عملیات پشتیبانی شده در API در سند مرجع API جستجوی نمودار دانش Google خلاصه شده است.
اصول JSON را یاد بگیرید
Google Knowledge Graph Search API دادهها را در قالب JSON برمیگرداند.
JSON (JavaScript Object Notation) یک قالب داده رایج و مستقل از زبان است که نمایش متنی ساده ای از ساختارهای داده دلخواه را ارائه می دهد. برای اطلاعات بیشتر، به json.org مراجعه کنید.