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

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

قبل البدء

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

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

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

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

وحدة التحكّم

  1. انتقل إلى Google Maps Platform > بيانات الاعتماد.

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

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

SDK للسحاب

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

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

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

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

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

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

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

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

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

وحدة التحكّم

  1. انتقل إلى Google Maps Platform > بيانات الاعتماد.

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

  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 مُدرَجة، ستحتاج إلى تفعيلها
  4. لإتمام التغييرات، انقر على حفظ.

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 , تثبيت Cloud SDK ، بالإضافة إلى الأوامر التالية:

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

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