الموافقة على الطلبات

متطلبات مصادقة واجهة برمجة التطبيقات لخدمة Search Console

يجب أن يتضمن كل طلب يرسله تطبيقك إلى Google Search Console API رمزًا مميزًا للتفويض. ويساعد الرمز المميز محرك البحث Google في التعرّف على تطبيقك.

نبذة عن بروتوكولات التفويض

يجب أن يستخدم تطبيقك OAuth 2.0 للسماح بالطلبات. ولا يُسمح باستخدام أي بروتوكولات أخرى للموافقة على الطلبات. إذا كان تطبيقك يستخدم ميزة تسجيل الدخول باستخدام حساب Google، ستتم معالجة بعض جوانب عملية الموافقة على الطلبات نيابةً عنك.

الموافقة على الطلبات باستخدام OAuth 2.0

يجب أن يتم السماح لجميع الطلبات إلى واجهة برمجة التطبيقات في Google Search Console عن طريق مستخدم تمت مصادقته.

تختلف تفاصيل عملية الموافقة على الطلبات لبروتوكول OAuth 2.0 نوعًا ما حسب نوع التطبيق الذي تكتبه. وتسري العملية العامة التالية على كل أنواع التطبيقات:

  1. عند إنشاء التطبيق، يجب تسجيله باستخدام وحدة التحكم في واجهة Google API. ويوفر محرك البحث Google المعلومات التي ستحتاجها في ما بعد، مثل معرّف العميل وسر العميل.
  2. تفعيل واجهة برمجة تطبيقات Google Search Console في وحدة تحكم واجهة برمجة تطبيقات Google. (يمكنك تخطّي هذه الخطوة إذا كانت واجهة برمجة التطبيقات غير مدرَجة في وحدة التحكم في واجهة Google API.)
  3. إذا احتاج التطبيق الدخول إلى بيانات المستخدِم، يطلب التطبيق من Google نطاقًا معينًا للدخول.
  4. يعرض Google شاشة الموافقة للمستخدم، ويطلب منه السماح لتطبيقك بطلب بعض بياناته.
  5. عند موافقة المستخدِم، يمنح Google تطبيقك رمز دخول قصير الأجل.
  6. يطلب تطبيقك بيانات المستخدِم، من خلال إرفاق رمز الدخول بالطلب.
  7. يعرض 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 للبيانات العامة مُرفقة بمعرّف يمكن أن يكون مفتاح واجهة برمجة تطبيقات أو رمز دخول.

للحصول على مفتاح واجهة برمجة تطبيقات:

  1. افتح صفحة بيانات الاعتماد في وحدة تحكم واجهة برمجة التطبيقات.
  2. تتيح واجهة برمجة التطبيقات هذه استخدام نوعَين من بيانات الاعتماد. أنشئ بيانات الاعتماد المناسبة لمشروعك:
    • OAuth 2.0: عندما يطلب تطبيقك بيانات المستخدم الخاصة، يجب أن يرسل رمز OAuth 2.0 المميز مع الطلب. يرسل التطبيق أولاً معرِّف عميل وربما سر عميل للحصول على رمز مميز. يمكنك إنشاء بيانات اعتماد OAuth 2.0 لتطبيقات الويب أو حسابات الخدمة أو التطبيقات المُثبَّتة.

      لمزيد من المعلومات، راجع وثائق OAuth 2.0.

    • مفاتيح واجهة برمجة التطبيقات: يجب أن يرسل الطلب الذي لا يوفر رمزًا مميزًا لبروتوكول OAuth 2.0 مفتاح واجهة برمجة التطبيقات. يحدد المفتاح مشروعك ويوفر إمكانية الوصول إلى واجهة برمجة التطبيقات والحصة والتقارير.

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

للحفاظ على أمان مفاتيح واجهة برمجة التطبيقات، اتبع أفضل الممارسات لاستخدام مفاتيح واجهة برمجة التطبيقات بشكل آمن.

بعد توفّر مفتاح واجهة برمجة تطبيقات، يمكن لتطبيقك إلحاق معلمة طلب البحث key=yourAPIKey بجميع عناوين URL للطلبات.

يعتبر مفتاح واجهة برمجة التطبيقات آمنًا للتضمين في عناوين URL، ولا يحتاج إلى أي تشفير.