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

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

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

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

قبل البدء

قبل أن تبدأ في استخدام واجهة برمجة تطبيقات JavaScript لـ "خرائط Google"، عليك إنشاء مشروع بحساب فوترة وتفعيل واجهة برمجة تطبيقات JavaScript لـ "خرائط Google". لمزيد من المعلومات، يُرجى الاطِّلاع على الإعداد في 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. لقبول الطلبات من قائمة المواقع الإلكترونية التي تقدّمها، اختَر مُحيل HTTP (مواقع الويب) من قائمة قيود التطبيق.
      2. يمكنك تحديد موقع إلكتروني واحد أو أكثر من المواقع الإلكترونية المُحيلة. ويمكن استخدام أحرف البدل لتفويض جميع النطاقات الفرعية (على سبيل المثال، تقبل *.google.com جميع المواقع الإلكترونية التي تنتهي بـ .google.com). ويجب تحديد https:// وhttp:// كما هو. ويجب استخدام تمثيل خاص لأنواع أخرى من بروتوكولات عناوين URL للمُحيل. على سبيل المثال، يمكنك تنسيق file:///path/to/ على أنّه __file_url__//path/to/*. بعد تفعيل المُحيلين، احرص على مراقبة استخدامك للتأكّد من توافقه مع توقعاتك. بروتوكولات المُحيل التالية متاحة: about://, app://, applewebdata://, asset://, chrome://, content://, file://, ftp://, ionic://, local://, ms-appx://, ms-appx-web://, ms-local-stream://, prism://, qrc://, res://, saphtmlp://.
    • قيود واجهة برمجة التطبيقات:
      1. انقر على تقييد المفتاح.
      2. اختَر Maps JavaScript API من القائمة المنسدلة Select APIs (اختيار واجهات برمجة التطبيقات). إذا لم يتم إدراج واجهة برمجة تطبيقات JavaScript للخرائط، عليك تفعيلها.
      3. إذا كان مشروعك يستخدم "مكتبة الأماكن"، اختَر أيضًا واجهة برمجة تطبيقات الأماكن. وبالمثل، إذا كان مشروعك يستخدم خدمات أخرى في واجهة برمجة التطبيقات المستندة إلى JavaScript (خدمة الاتجاهات وخدمة مصفوفة المسافة و/أو خدمة الارتفاع و/أو خدمة الترميز الجغرافي)، عليك أيضًا تفعيل واجهة برمجة التطبيقات ذات الصلة واختيارها في هذه القائمة.
  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="maps-backend.googleapis.com"
    --allowed-referrers="referer

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

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

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

  <script async defer src="https://maps.googleapis.com/maps/api/js?key=YOUR_API_KEY&callback=initMap"></script>

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