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

اختيار النظام الأساسي: Android iOS JavaScript خدمة الويب

قبل البدء

قبل بدء استخدام حزمة تطوير برامج "الأماكن" لنظام التشغيل Android، تحتاج إلى مشروع يتضمّن حساب فوترة وملف حزمة تطوير برامج "الأماكن" لنظام التشغيل Android مفعّلاً. لمزيد من المعلومات، يُرجى الاطّلاع على الإعداد في وحدة تحكّم Cloud.

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

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

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

وحدة التحكّم

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

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

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

SDK للسحاب

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

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

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

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

عند تقييد مفتاح واجهة برمجة التطبيقات، عليك تقديم الملف المرجعي لشهادة SHA-1 الخاص بمفتاح التوقيع الذي تم استخدامه لتوقيع التطبيق. هناك نوعان من الشهادات:

  • شهادة تصحيح الأخطاء: لا تستخدِم هذا النوع من الشهادات إلا مع التطبيقات التي تختبرها والرموز البرمجية الأخرى غير المخصّصة للإصدار العلني. لا تحاول نشر تطبيق موقَّع باستخدام شهادة تصحيح أخطاء. تنشئ أدوات حزمة تطوير البرامج (SDK) لنظام التشغيل Android هذه الشهادة تلقائيًا عند تشغيل إصدار debugging.
  • شهادة الإصدار: استخدِم هذه الشهادة عندما تكون مستعدًا لإصدار تطبيقك في متجر تطبيقات. تنشئ أدوات حزمة تطوير البرامج (SDK) لنظام التشغيل Android هذه الشهادة عند تشغيل إصدار الإصدار.

لمزيد من المعلومات حول توقيع تطبيقات Android وشهاداتها، يُرجى الاطّلاع على دليل توقيع تطبيقك.

للحصول على تعليمات حول كيفية العثور على الملف المرجعي لشهادة التوقيع، اطّلِع على المراجع أدناه:

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

وحدة التحكّم

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

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

  2. اختَر مفتاح واجهة برمجة التطبيقات الذي تريد فرض قيود عليه. ستظهر صفحة موقع مفتاح واجهة برمجة التطبيقات.
  3. ضمن قيود المفاتيح، اضبط القيود التالية:
    • قيود التطبيق:
      1. اختَر تطبيقات Android.
      2. انقر على + إضافة اسم الحزمة وبصمة الإصبع.
      3. أدخِل اسم الحزمة والملف المرجعي لشهادة SHA-1. على سبيل المثال: 
        com.example.android.mapexample
         
        BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75
    • القيود المفروضة على واجهة برمجة التطبيقات:
      1. انقر على تقييد المفتاح.
      2. اختَر Places API أو Places API (جديدة) من القائمة المنسدلة اختيار واجهات برمجة التطبيقات، ولكن ليس كليهما. إذا لم تكن Places API مُدرَجة، عليك تفعيلها.
  4. لإنهاء التغييرات، انقر على حفظ.

SDK للسحاب

حزمة تطوير برامج الأماكن لأجهزة Android (الإصدار الجديد)

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

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

أزِل القيود الحالية المفروضة على المفتاح الحالي. 

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

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

gcloud services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=places.googleapis.com
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

حزمة تطوير برامج الأماكن لأجهزة Android

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

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

أزِل القيود الحالية المفروضة على المفتاح الحالي. 

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

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

gcloud services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=places-backend.googleapis.com
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

الخطوات التالية

بعد الحصول على مفتاح واجهة برمجة التطبيقات، أنشئ مشروعًا وضبطه كما هو موضّح في مقالة إعداد مشروع في "استوديو Android".