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

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

قبل البدء

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

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

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

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

وحدة التحكم

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

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

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

Cloud SDK

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

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

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

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

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

  • شهادة تصحيح الأخطاء: لا تستخدم نوع الشهادة هذا إلا مع التطبيقات التي تختبرها والرموز البرمجية الأخرى غير الإنتاجية. لا تحاول نشر تطبيق موقَّع باستخدام شهادة تصحيح أخطاء. تنشئ أدوات حزمة تطوير البرامج (SDK) لنظام التشغيل Android هذه الشهادة تلقائيًا عند تشغيل إصدار تصحيح الأخطاء.
  • شهادة الإصدار: استخدم هذه الشهادة عندما تكون مستعدًا لإصدار تطبيقك في متجر التطبيقات. تنشئ أدوات حزمة تطوير البرامج (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 (جديد) من القائمة المنسدلة Select APIs (اختيار واجهات برمجة التطبيقات)، ولكن ليس كليهما. إذا لم تكن واجهة Places API مُدرَجة، يجب enableها.
  4. لوضع اللمسات الأخيرة على التغييرات، انقر على حفظ.

Cloud SDK

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

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

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="places.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

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

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

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="places-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

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

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