المتطلّبات الأساسية

قبل أن تتمكّن من بدء ترميز تطبيق العميل الأول، عليك إجراء بعض الخطوات التالية، إذا لم يسبق لك إجراؤها:

الحصول على حساب Google

تحتاج إلى حساب Google من أجل إنشاء مشروع في Google API Console. إذا كان لديك حساب، تكون قد انتهيت من عملية الإعداد.

قد تحتاج أيضًا إلى حساب Google منفصل لأغراض الاختبار.

إنشاء مشروع لعميلك

قبل أن تتمكّن من إرسال طلبات إلى Google Knowledge Graph Search API، عليك تزويد Google بمعلومات حول عميلك وتفعيل إمكانية الوصول إلى واجهة برمجة التطبيقات. ويمكنك إجراء ذلك عن طريق الاستعانة بوحدة التحكم في واجهة Google API لإنشاء مشروع (أي مجموعة معرَّفة من الإعدادات ومعلومات الدخول إلى واجهة برمجة التطبيقات) ولتسجيل تطبيقك.

لبدء استخدام Google Knowledge Graph Search API، عليك أولاً استخدام أداة الإعداد التي تقدّم لك إرشادات خلال عملية إنشاء المشروع في وحدة التحكم في Google API وتفعيل واجهة برمجة التطبيقات وإنشاء بيانات الاعتماد.

أنشئ مفتاح واجهة برمجة التطبيقات لتطبيقك إذا لم يسبق لك إجراء ذلك، وذلك بالنقر على إنشاء بيانات اعتماد > مفتاح واجهة برمجة التطبيقات. بعد ذلك، ابحث عن مفتاح واجهة برمجة التطبيقات في قسم مفاتيح واجهة برمجة التطبيقات.

التعرّف على أساسيات REST

هناك طريقتان لاستدعاء واجهة برمجة التطبيقات:

إذا قرّرت عدم استخدام مكتبات العملاء، عليك فهم أساسيات REST.

‫REST هو أسلوب لبنية البرامج يقدّم نهجًا ملائمًا ومتسقًا لطلب البيانات وتعديلها.

يشير اختصار REST إلى Representational State Transfer. في سياق Google APIs، يشير ذلك إلى استخدام أفعال HTTP لاسترداد وتعديل تمثيلات البيانات التي تخزّنها Google.

في نظام RESTful، يتم تخزين الموارد في مستودع بيانات، ويرسل العميل طلبًا بأن ينفّذ الخادم إجراءً معيّنًا (مثل إنشاء مورد أو استرجاعه أو تعديله أو حذفه)، وينفّذ الخادم الإجراء ويرسل ردًا، غالبًا في شكل تمثيل للمورد المحدّد.

في واجهات برمجة التطبيقات RESTful من Google، يحدّد العميل إجراءً باستخدام فعل HTTP مثل POST أو GET أو PUT أو DELETE. ويحدّد موردًا باستخدام معرّف موارد منتظم فريد عالميًا بالشكل التالي:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

بما أنّ جميع موارد واجهة برمجة التطبيقات تتضمّن عناوين URL فريدة يمكن الوصول إليها من خلال HTTP، فإنّ بروتوكول REST يتيح ميزة تخزين البيانات مؤقتًا ويتم تحسينه للعمل مع البنية الأساسية الموزّعة للويب.

قد تكون تعريفات الطرق في مستندات معايير HTTP 1.1 مفيدة، إذ تتضمّن مواصفات GET وPOST وPUT وDELETE.

واجهة برمجة التطبيقات REST في Google Knowledge Graph Search API

تتمّ ربط عمليات Google Knowledge Graph Search API مباشرةً بأفعال REST HTTP.

في ما يلي التنسيقات المحدّدة لعناوين URL في Knowledge Graph Search API من Google:

https://kgsearch.googleapis.com/v1/entities:search?query=your_query&parameters

يمكنك الاطّلاع على المجموعة الكاملة لمعرّفات الموارد المنتظمة (URI) المستخدَمة لكلّ عملية متوافقة في واجهة برمجة التطبيقات في مستند مرجع Google Knowledge Graph Search API.

التعرّف على أساسيات تنسيق JSON

تُرجِع واجهة برمجة التطبيقات Google Knowledge Graph Search API البيانات بتنسيق JSON.

‫JSON (JavaScript Object Notation) هو تنسيق بيانات شائع لا يعتمد على اللغة، ويقدّم تمثيلاً نصيًا بسيطًا لبنى البيانات العشوائية. لمزيد من المعلومات، يُرجى الاطّلاع على json.org.