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

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

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

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

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

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

وحدة التحكّم

  1. انتقل إلى Google Maps Platform > بيانات الاعتماد.

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

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

SDK للسحاب

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

يمكنك قراءة المزيد عن حزمة تطوير البرامج (SDK) في Google Cloud , تثبيت Cloud SDK ، بالإضافة إلى الأوامر التالية:

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

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

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

وحدة التحكّم

  1. انتقل إلى Google Maps Platform > بيانات الاعتماد.

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

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

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="airquality.googleapis.com"
    --allowed-ips="IP_ADDRESS"

يمكنك قراءة المزيد عن حزمة تطوير البرامج (SDK) في Google Cloud , تثبيت Cloud SDK ، بالإضافة إلى الأوامر التالية:

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

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

https://airquality.googleapis.com/v1/currentConditions:lookup?key=YOUR_API_KEY

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