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

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

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

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

قبل البدء

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

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

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

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

وحدة التحكّم

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

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

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

Cloud SDK

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

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

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

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

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

وحدة التحكّم

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

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

  2. اختَر مفتاح واجهة برمجة التطبيقات الذي تريد إعداد قيود عليه. تظهر صفحة موقع مفتاح واجهة برمجة التطبيقات.
  3. ضمن القيود الرئيسية، اضبط القيود التالية:
    • قيود التطبيق:
      1. لقبول الطلبات من قائمة عناوين IP لخوادم الويب التي تقدّمها، اختَر عناوين IP (خوادم الويب، ومهام cron، وما إلى ذلك) من قائمة قيود التطبيق. حدِّد عنوان IPv4 أو IPv6 واحدًا أو شبكة فرعية تستخدم تدوين CIDR (مثل 192.168.0.0/22). بما أنّ طلب خدمة الويب يتعلّق بخدمة الويب ويتحقّق من عنوان IP الخارجي مقارنةً بالقيود المفروضة على مفتاح واجهة برمجة التطبيقات، استخدِم عنوان IP العلني للخادم.
    • قيود واجهة برمجة التطبيقات:
      1. انقر على تقييد المفتاح.
      2. اختَر Elevation API من القائمة المنسدلة Select APIs (واجهات برمجة التطبيقات). إذا كانت واجهة برمجة التطبيقات 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 وتثبيت Cloud SDK والطلبات التالية:

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

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

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

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