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

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

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

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

وحدة التحكّم

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

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

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

Cloud SDK

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

يمكنك الاطّلاع على مزيد من المعلومات عن Google Cloud SDK وتثبيت 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. حدد حزمة SDK للتنقل من القائمة المنسدلة تحديد واجهات برمجة التطبيقات. إذا لم تكن حزمة SDK للتنقّل غير مدرَجة، عليك 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"

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

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

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

إعداد مشروعك على "استوديو Android"