متطلبات مصادقة واجهة برمجة التطبيقات لخدمة Search Console
عندما يرسل تطبيقك طلبًا إلى واجهة برمجة التطبيقات في Google Search Console، يجب أن يحتوي هذا الطلب على رمز موافقة مميز. ويساعد الرمز المميز محرك البحث Google في التعرّف على تطبيقك.
نبذة عن بروتوكولات التفويض
يجب أن يستخدم تطبيقك OAuth 2.0 للسماح بالطلبات. ولا يُسمح باستخدام أي بروتوكولات أخرى للموافقة على الطلبات. إذا كان تطبيقك يستخدم ميزة تسجيل الدخول باستخدام حساب Google، ستتم معالجة بعض جوانب عملية الموافقة على الطلبات نيابةً عنك.
الموافقة على الطلبات باستخدام OAuth 2.0
يجب أن يوافق مستخدم مصادَق عليه على كلّ الطلبات الموجّهة إلى واجهة برمجة التطبيقات في Google Search Console.
تختلف تفاصيل عملية الموافقة على الطلبات لبروتوكول OAuth 2.0 نوعًا ما حسب نوع التطبيق الذي تكتبه. وتسري العملية العامة التالية على كل أنواع التطبيقات:
- عند إنشاء التطبيق، يجب تسجيله باستخدام وحدة التحكم في واجهة Google API. ويوفر محرك البحث Google المعلومات التي ستحتاجها في ما بعد، مثل معرّف العميل وسر العميل.
- يجب تفعيل واجهة برمجة التطبيقات لخدمة Google Search Console في وحدة التحكم في واجهة Google API. (يمكنك تخطّي هذه الخطوة إذا كانت واجهة برمجة التطبيقات غير مدرَجة في وحدة التحكم في واجهة Google API.)
- إذا احتاج التطبيق الدخول إلى بيانات المستخدِم، يطلب التطبيق من Google نطاقًا معينًا للدخول.
- يعرض Google شاشة الموافقة للمستخدم، ويطلب منه السماح لتطبيقك بطلب بعض بياناته.
- عند موافقة المستخدِم، يمنح Google تطبيقك رمز دخول قصير الأجل.
- يطلب تطبيقك بيانات المستخدِم، من خلال إرفاق رمز الدخول بالطلب.
- يعرض Google البيانات المطلوبة بعد تحققه من صلاحية طلبك والرمز المميز.
تستلزم بعض التدفقات إجراء خطوات إضافية، مثل استخدام رموز مميزة للتحديث للحصول على رموز دخول جديدة. لمزيد من المعلومات التفصيلية حول العمليات المتعلقة بمختلف أنواع التطبيقات، راجِع مستندات بروتوكول OAuth 2.0 في Google.
في ما يلي معلومات عن نطاق OAuth 2.0 في واجهة برمجة التطبيقات في Google Search Console:
| النطاق | المعنى |
|---|---|
https://www.googleapis.com/auth/webmasters |
الإذن بالقراءة والتعديل |
https://www.googleapis.com/auth/webmasters.readonly |
الإذن بالقراءة فقط |
لطلب الدخول باستخدام بروتوكول OAuth 2.0، يحتاج التطبيق معلومات عن النطاق، بالإضافة إلى المعلومات التي يوفّرها Google عند تسجيل التطبيق (مثل معرِّف العميل وسر العميل).
نصيحة: يمكن لمكتبات عملاء Google APIs معالجة جزء من عملية السماح بالنيابة عنك. وتتوفّر هذه المكتبات للعديد من لغات البرمجة، ويمكنك الاطّلاع على صفحة المكتبات والنماذج للحصول على مزيد من التفاصيل.
متطلبات مصادقة واجهة برمجة التطبيقات لأدوات الاختبار في Search Console
الحصول على مفتاح واجهة برمجة التطبيقات واستخدامه
يجب أن تكون طلبات البيانات الموجّهة إلى Search Console Testing Tools API للحصول على بيانات علنية مزوّدة بمعرّف يمكن أن يكون مفتاح واجهة برمجة تطبيقات أو رمز دخول.
للحصول على مفتاح واجهة برمجة التطبيقات:
- افتح صفحة بيانات الاعتماد في وحدة تحكم واجهة برمجة التطبيقات.
-
تتيح واجهة برمجة التطبيقات هذه نوعين من بيانات الاعتماد.
أنشئ بيانات الاعتماد المناسبة لمشروعك:
-
OAuth 2.0: عندما يطلب تطبيقك بيانات مستخدم خاصة، يجب أن يرسل رمز OAuth 2.0 المميز مع الطلب. يرسل تطبيقك أولاً معرِّف عميل، وربما سر العميل، للحصول على رمز مميّز. ويمكنك إنشاء بيانات اعتماد OAuth 2.0 لتطبيقات الويب أو حسابات الخدمة أو التطبيقات المثبّتة.
لمزيد من المعلومات، يُرجى الاطِّلاع على مستندات OAuth 2.0.
-
مفاتيح واجهة برمجة التطبيقات: في حال عدم توفير رمز OAuth 2.0 المميز، يجب أن يرسل مفتاح واجهة برمجة التطبيقات. يحدد المفتاح مشروعك ويوفر إمكانية الوصول إلى واجهة برمجة التطبيقات والحصة وتقاريره.
تتيح واجهة برمجة التطبيقات عدة أنواع من القيود المفروضة على مفاتيح واجهة برمجة التطبيقات. إذا لم يكن مفتاح واجهة برمجة التطبيقات الذي تحتاجه متوفّرًا، أنشِئ مفتاح واجهة برمجة التطبيقات في "وحدة التحكّم" بالنقر على إنشاء بيانات اعتماد > مفتاح واجهة برمجة التطبيقات. يمكنك فرض قيود على المفتاح قبل استخدامه في مرحلة الإنتاج من خلال النقر على تقييد المفتاح واختيار أحد القيود.
-
للحفاظ على أمان مفاتيح واجهة برمجة التطبيقات، يمكنك اتّباع أفضل الممارسات لاستخدام مفاتيح واجهة برمجة التطبيقات بأمان.
بعد الحصول على مفتاح واجهة برمجة التطبيقات، يمكن لتطبيقك إلحاق معلَمة طلب البحث key=yourAPIKey بجميع عناوين URL للطلبات.
يمكن تضمين مفتاح واجهة برمجة التطبيقات في عناوين URL بدون الحاجة إلى أيّ ترميز.