استخدام مفاتيح واجهة برمجة التطبيقات مع Elevation API

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

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

قبل البدء

قبل بدء استخدام واجهة برمجة التطبيقات Elevation API، تحتاج إلى مشروع يتضمّن حساب فوترة وتم تفعيل واجهة برمجة التطبيقات Elevation API. للحصول على مزيد من المعلومات، يُرجى الاطِّلاع على الإعداد في Cloud Console.

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

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

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

وحدة التحكّم

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

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

  2. في صفحة بيانات الاعتماد، انقر على إنشاء بيانات اعتماد > مفتاح واجهة برمجة التطبيقات.
    يعرض مربّع الحوار مفتاح واجهة برمجة التطبيقات الذي تم إنشاؤه مفتاح واجهة برمجة التطبيقات الذي تم إنشاؤه حديثًا.
  3. انقر على إغلاق.
    يتم إدراج مفتاح واجهة برمجة التطبيقات الجديد في صفحة بيانات الاعتماد ضمن مفاتيح واجهة برمجة التطبيقات.
    (تذكَّر حظر واجهة برمجة التطبيقات قبل استخدامها في الإنتاج).

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

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

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

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

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

وحدة التحكّم

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

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

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

Cloud SDK

إدراج المفاتيح الحالية

gcloud services api-keys list --project="PROJECT"

يمكنك إزالة القيود الحالية على المفتاح الحالي.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

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

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --api-target="elevation-backend.googleapis.com"
    --allowed-ips="IP_ADDRESS"

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

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

يجب تضمين مفتاح واجهة برمجة التطبيقات مع كل طلب Elevation API. في المثال التالي، استبدِل YOUR_API_KEY بمفتاح واجهة برمجة التطبيقات.

https://maps.googleapis.com/maps/api/elevation/json?locations=39.7391536,-104.9847034&key=YOUR_API_KEY

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