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