استخدام مفاتيح واجهة برمجة التطبيقات مع Distance Matrix API (الإصدار القديم)

تحمي Google منتجات "منصة خرائط Google" من الاستخدام غير المصرّح به من خلال حصر طلبات البيانات من واجهة برمجة التطبيقات على تلك التي توفّر بيانات اعتماد المصادقة المناسبة. تكون بيانات الاعتماد هذه على شكل مفتاح واجهة برمجة التطبيقات، وهو سلسلة فريدة من الأحرف الأبجدية الرقمية تربط حسابك على Cloud Billing بمشروعك وبواجهة برمجة التطبيقات أو حزمة تطوير البرامج (SDK) المحدّدة.

يوضّح هذا الدليل كيفية إنشاء مفتاح واجهة برمجة التطبيقات وحصره واستخدامه في "منصة خرائط Google".

قبل البدء

قبل البدء في استخدام Distance Matrix API (الإصدار القديم)، يجب أن يكون لديك مشروع يتضمّن حساب فوترة وأن تكون Distance Matrix API (الإصدار القديم) مفعَّلة. لمزيد من المعلومات، يُرجى الاطّلاع على مقالة الإعداد في Cloud Console.

إنشاء مفاتيح واجهة برمجة التطبيقات

مفتاح واجهة برمجة التطبيقات هو معرّف فريد يصادق على الطلبات المرتبطة بمشروعك لأغراض الاستخدام والفوترة. يجب أن يكون لديك مفتاح واجهة برمجة تطبيقات واحد على الأقل مرتبط بمشروعك. لإنشاء مفتاح جديد أو إضافة واجهة برمجة تطبيقات أو حزمة تطوير برامج (SDK) إلى مفتاح حالي، اتّبِع التعليمات التالية.

وحدة التحكّم

  1. انتقِل إلى صفحة منصة خرائط Google > المفاتيح وبيانات الاعتماد.

    الانتقال إلى صفحة "المفاتيح وبيانات الاعتماد"

  2. اختَر مشروعك إذا طُلب منك ذلك.
  3. نفّذ أيًا مما يلي:

    • إنشاء مفتاح جديد:

      1. انقر على إنشاء بيانات الاعتماد > مفتاح واجهة برمجة التطبيقات.
      2. في لوحة إنشاء مفتاح واجهة برمجة التطبيقات، افتح قائمة اختيار قيود واجهة برمجة التطبيقات.
      3. امسح أي واجهات برمجة تطبيقات لا يحتاجها هذا المفتاح، وتأكَّد من بقاء Distance Matrix API محدَّدة.
      4. انقر على إنشاء. تعرض اللوحة مفتاح واجهة برمجة التطبيقات الجديد.
    • استخدام مفتاح حالي:

      1. انقر على اسم المفتاح.
      2. في قائمة اختيار قيود واجهة برمجة التطبيقات، اختَر Distance Matrix API.
      3. انقر على حفظ.

    لا يؤدي اختيار واجهة برمجة تطبيقات هنا إلى تفعيلها. تأكَّد من تفعيل Distance Matrix API في صفحة مكتبة واجهة برمجة التطبيقات.

  4. للاطّلاع على سلسلة المفاتيح لاحقًا، انتقِل إلى صفحة المفاتيح وبيانات الاعتماد وانقر على عرض المفتاح للمفتاح المطلوب.

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

gcloud

استبدِل PROJECT_ID برقم تعريف مشروعك في الأوامر التالية.

  • إنشاء مفتاح جديد: نفِّذ الأمر التالي، واستبدِل DISPLAY_NAME باسم المفتاح.

    gcloud services api-keys create \
        --project="PROJECT_ID" \
        --display-name="DISPLAY_NAME" \
        --api-target=service=distance-matrix-backend.googleapis.com

    يمكنك الاطّلاع على مزيد من المعلومات حول Google Cloud SDK وتثبيت Cloud SDK والأوامر التالية:

  • استخدام مفتاح حالي: نفِّذ الأمر التالي، واستبدِل KEY_ID بمعرّف المفتاح. تحتفظ العلامة --append بواجهات برمجة التطبيقات التي يسمح بها المفتاح حاليًا. وبدونها، يستبدلها الأمر.

    gcloud services api-keys update KEY_ID \
        --project="PROJECT_ID" \
        --append \
        --api-target=service=distance-matrix-backend.googleapis.com

    يمكنك الاطّلاع على مزيد من المعلومات حول Google Cloud SDK وتثبيت Cloud SDK والأوامر التالية:

    معرّف المفتاح ليس سلسلة المفتاح أو اسم العرض. للعثور عليه، شغِّل gcloud services api-keys list --project="PROJECT_ID". رقم التعريف هو الجزء الأخير من حقل name: projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

للاطّلاع على سلسلة المفاتيح، شغِّل gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

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

تنصح Google بشدة بتقييد مفاتيح واجهة برمجة التطبيقات من خلال قصر استخدامها على واجهات برمجة التطبيقات اللازمة لتطبيقك فقط. يؤدي فرض قيود على مفاتيح واجهة برمجة التطبيقات إلى تعزيز أمان تطبيقك من خلال حمايته من الطلبات غير المبرَّرة. أنت مسؤول ماليًا عن الرسوم الناتجة عن إساءة استخدام مفاتيح واجهة برمجة التطبيقات غير المقيّدة. لمزيد من المعلومات، يُرجى الاطّلاع على أفضل ممارسات أمان واجهة برمجة التطبيقات.

لفرض قيود على مفتاح واجهة برمجة التطبيقات، اتّبِع الخطوات التالية:

وحدة التحكّم

  1. انتقِل إلى صفحة منصة خرائط Google > المفاتيح وبيانات الاعتماد.

    الانتقال إلى صفحة "المفاتيح وبيانات الاعتماد"

  2. اختَر مفتاح واجهة برمجة التطبيقات الذي تريد فرض قيود عليه. ستظهر صفحة خصائص مفتاح واجهة برمجة التطبيقات.
  3. ضمن قيود المفاتيح، اضبط القيود التالية:
    • قيود التطبيق:
      1. لقبول الطلبات من قائمة عناوين IP لخادم الويب التي تقدّمها، اختَر عناوين IP ضمن قيود التطبيق. حدِّد عنوان IPv4 أو IPv6 واحدًا أو أكثر، أو شبكة فرعية باستخدام تدوين CIDR. يجب أن تتطابق عناوين IP مع عنوان المصدر الذي ترصده خوادم "منصة خرائط Google". إذا كنت تستخدم ترجمة عنوان الشبكة (NAT)، سيتوافق ذلك عادةً مع عنوان IP العام لجهازك.
    • القيود المفروضة على واجهة برمجة التطبيقات:
      1. في اختيار قيود واجهة برمجة التطبيقات، تأكَّد من اختيار Distance Matrix API. إذا لم يكن مدرجًا، عليك تفعيله.
  4. لإتمام التغييرات، انقر على حفظ.

gcloud

نفِّذ الأمر التالي: استبدِل KEY_ID برقم تعريف المفتاح وPROJECT_ID برقم تعريف مشروعك. للعثور على معرّف المفتاح، شغِّل gcloud services api-keys list --project="PROJECT_ID". رقم التعريف هو الجزء الأخير من حقل name.

gcloud services api-keys update KEY_ID \
    --project="PROJECT_ID" \
    --append \
    --api-target=service=distance-matrix-backend.googleapis.com \
    --allowed-ips="IP_ADDRESS"

يمكنك الاطّلاع على مزيد من المعلومات حول Google Cloud SDK وتثبيت Cloud SDK والأوامر التالية:

إضافة مفتاح واجهة برمجة التطبيقات إلى طلبك

يجب تضمين مفتاح واجهة برمجة التطبيقات مع كل طلب من Distance Matrix API (الإصدار القديم). في المثال التالي، استبدِل YOUR_API_KEY بمفتاح واجهة برمجة التطبيقات:

https://maps.googleapis.com/maps/api/distancematrix/json?origins=Seattle&destinations=San+Francisco&key=YOUR_API_KEY

يجب استخدام HTTPS للطلبات التي تستخدم مفتاح واجهة برمجة التطبيقات.