إعداد الوصول إلى واجهة برمجة تطبيقات REST في Google Cloud Search

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

يجب ضبط الوصول إلى واجهة برمجة تطبيقات REST في Google Cloud Search قبل أن تتمكن من استخدام واجهة برمجة التطبيقات هذه مباشرة أو من خلال حزمة تطوير البرامج (SDK). ويتناول هذا المستند الخطوات اللازمة لاستخدام واجهة برمجة تطبيقات REST في Google Cloud Search.

1- إنشاء مشروع واجهة برمجة التطبيقات

لتفعيل واجهة برمجة التطبيقات، عليك أولاً إنشاء مشروع Google Cloud Platform. يشكّل هذا المشروع أساس إنشاء جميع خدمات Google Cloud Platform (GCP) وتفعيلها واستخدامها، بما في ذلك إدارة واجهات برمجة التطبيقات وتفعيل الفوترة وإضافة المتعاونين وإزالتهم وإدارة الأذونات.

  1. افتح Google Cloud Console.

  2. في أعلى الصفحة، انقر على على يسار "Google Cloud Console". يظهر مربع حوار يتضمن المشاريع الحالية.

  3. انقر على مشروع جديد. تظهر شاشة "مشروع جديد".

  4. أدخِل اسم مشروع في الحقل اسم المشروع.

  5. (اختياري) انقر على تعديل لتعديل رقم تعريف المشروع. لا يمكن تغيير رقم تعريف المشروع بعد إنشاء المشروع، لذا اختَر رقم تعريف يستوفي احتياجاتك طوال مدة المشروع.

  6. لتصفّح المواقع الجغرافية للمشروع، انقر على تصفّح.

  7. انقر على موقع مشروعك، ثم انقر على اختيار.

  8. انقر على إنشاء. تنتقل وحدة التحكم إلى صفحة لوحة البيانات. يتم إنشاء المشروع في غضون بضع دقائق.

لمزيد من المعلومات حول إنشاء المشاريع وإدارتها، يُرجى الرجوع إلى إنشاء المشاريع وإدارتها.

2- تفعيل واجهة برمجة التطبيقات

وعليك تفعيل واجهة برمجة تطبيقات REST في Cloud Search وإنشاء حساب خدمة للحصول على بيانات الاعتماد.

  1. للتأكّد من أنك تعمل في المشروع الذي تم إنشاؤه حديثًا، انقر على رمز إلى يسار بانر Google Cloud Console واختَر مشروعك الذي تم إنشاؤه حديثًا.
  2. انقر على تفعيل واجهات برمجة التطبيقات والخدمات. تظهر صفحة "مرحبًا بك في مكتبة واجهة برمجة التطبيقات".
  3. انتقِل إلى واجهة برمجة تطبيقات Google Cloud Search.
  4. انقر على تفعيل. ستظهر صفحة "نظرة عامة".

لمزيد من المعلومات حول تفعيل واجهات برمجة التطبيقات وإيقافها، يُرجى الرجوع إلى إدارة واجهات برمجة التطبيقات في Google Cloud Console

3. إنشاء بيانات اعتماد حساب الخدمة

  1. في وحدة تحكم Cloud Platform، انقر على بيانات الاعتماد في شريط التنقل الأيمن. ستظهر صفحة "بيانات الاعتماد".
  2. من القائمة المنسدلة إنشاء بيانات الاعتماد، اختر حساب الخدمة. تظهر صفحة "إنشاء حساب خدمة".
  3. أدخِل اسمًا في الحقل اسم حساب الخدمة.
  4. (اختياري) عدِّل رقم تعريف حساب الخدمة.
  5. انقر على إنشاء. ستظهر شاشة "أذونات حساب الخدمة".
  6. انقر على متابعة. تظهر شاشة "منح المستخدمين حق الوصول إلى حساب الخدمة هذا".
  7. انقر على إنشاء مفتاح، ثم انقر على تم. يظهر مربع حوار "تم حفظ مفتاح خاص لجهاز الكمبيوتر التابع لك" وسيتم تنزيل نسخة من المفتاح الخاص إلى جهاز الكمبيوتر.
  8. انقر على إغلاق.

لمزيد من المعلومات عن حسابات الخدمة، يُرجى الرجوع إلى حسابات الخدمة وتطبيقات الويب والتطبيقات المثبّتة

4. تحديد عنوان البريد الإلكتروني

  1. من وحدة تحكم Cloud Platform، اختَر المشروع الذي أنشأته في أعلى الصفحة.
  2. انقر على قائمة التنقل على يمين بانر Google Cloud Console.
  3. انقر على إدارة الهوية وإمكانية الوصول والمشرف > حسابات الخدمة.
  4. في القائمة، ضمن "رقم تعريف حساب الخدمة"، دوِّن عنوان البريد الإلكتروني الذي تم إنشاؤه الذي يحدّد حساب الخدمة الذي تم ضبطه. يُستخدم عنوان البريد الإلكتروني هذا عند إضافة مصدر بيانات إلى Cloud Search.

5. إعداد دعم الجهات الخارجية

قبل طلب أي واجهات برمجة تطبيقات Cloud Search أخرى، عليك إعداد دعم الجهات الخارجية لخدمة Google Cloud Search.

لإعداد دعم الجهات الخارجية في Cloud Search:

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

  2. استخدِم ملعب OAuth 2 في Google للحصول على رمز دخول:

    1. انقر على الإعدادات وتحقَّق من مستخدم بيانات اعتمادك الخاصة.
    2. أدخِل معرِّف العميل وسر العميل من الخطوة 1.
    3. انقر على إغلاق.
    4. في حقل النطاقات، اكتب https://www.googleapis.com/auth/cloud_search.settings وانقر على تفويض. يعرض ملعب OAuth 2 رمز تفويض.
    5. انقر على رمز تفويض Exchange للرموز المميزة. يتم عرض رمز مميز.
  3. لإعداد دعم الجهات الخارجية لخدمة Cloud Search، يمكنك استخدام الأمر curl التالي. تأكّد من استبدال [YOUR_ACCESS_TOKEN] بالرمز المميّز الذي تم الحصول عليه في الخطوة 2.

    curl --request POST \
    'https://cloudsearch.googleapis.com/v1:initializeCustomer' \
      --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
      --header 'Accept: application/json' \
      --header 'Content-Type: application/json' \
      --data '{}' \
      --compressed
    

    إذا كانت الاستجابة ناجحة، يحتوي نص الاستجابة على مثال operation. على سبيل المثال:

    {
    name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
    }
    

    في حال عدم التمكُّن من ذلك، يمكنك التواصل مع فريق دعم Cloud Search.

  4. استخدِم operations.get للتحقّق من أنّه تم إعداد الدعم التابع لجهة خارجية:

    curl \
    'https://cloudsearch.googleapis.com/v1/operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY?key=
    [YOUR_API_KEY]' \
    --header 'Authorization: Bearer [YOUR_ACCESS_TOKEN]' \
    --header 'Accept: application/json' \
    --compressed
    

    عندما تكتمل عملية إعداد الجهة الخارجية، تحتوي على الحقل done الذي تم ضبطه على true. مثال:

    {
    name: "operations/customers/01b3fqdm/lro/AOIL6eBv7fEfiZ_hUSpm8KQDt1Mnd6dj5Ru3MXf-jri4xK6Pyb2-Lwfn8vQKg74pgxlxjrY"
    done: true
    }
    

الخطوات التالية

إليك بعض الخطوات التي يمكنك اتخاذها:

  1. إذا كنت تخطّط لاستخدام Google Cloud Search من خلال مستودع بيانات لا يتبع Google، مثل Microsoft® SharePoint® ، عليك إنشاء مصدر بيانات. للحصول على تعليمات حول إضافة مصدر بيانات، راجِع إضافة مصدر بيانات إلى البحث.

  2. بعد إعداد مصدر البيانات، يمكنك إنشاء مخطط وتسجيله لتحديد طريقة تمثيل Google Cloud Search للبيانات في المستودع.