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

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

قبل البدء

قبل بدء استخدام حزمة تطوير البرامج بالاستناد إلى بيانات "خرائط Google" لتطبيقات Android، تحتاج إلى مشروع مزوّد بحساب فوترة وحزمة SDK الخاصة بخرائط Google لنظام التشغيل 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. اختر حزمة تطوير البرامج بالاستناد إلى بيانات "خرائط Google" لنظام التشغيل Android من القائمة المنسدلة اختيار واجهات برمجة التطبيقات. إذا لم تكن حزمة تطوير البرامج بالاستناد إلى بيانات "خرائط Google" لتطبيقات Android مدرَجة، عليك enable.
  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-android-backend.googleapis.com"
    --allowed-application="sha1_fingerprint=SHA1_FINGERPRINT,package_name=ANDROID_PACKAGE_NAME"

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

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

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