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

توفّر ميزة فحص التطبيقات من Firebase الحماية للطلبات الواردة من تطبيقك إلى "منصة خرائط Google" من خلال حظر الزيارات الواردة من مصادر غير التطبيقات الشرعية. ويتم ذلك من خلال البحث عن رمز مميّز من مقدّم خدمة المصادقة، مثل reCAPTCHA Enterprise. يساعد دمج تطبيقاتك مع ميزة "التحقّق من التطبيق" في الحماية من الطلبات الضارة، وبالتالي لا يتم تحصيل رسوم منك مقابل طلبات البيانات غير المصرّح بها من واجهة برمجة التطبيقات.

هل ميزة "فحص التطبيقات" مناسبة لي؟

ننصح باستخدام ميزة "فحص التطبيقات" في معظم الحالات، ولكنّها غير مطلوبة أو غير متاحة في الحالات التالية:

  • أنت تستخدم الإصدار الأصلي من حزمة SDK للأماكن. لا تتوفّر ميزة "فحص التطبيقات" إلا في Places SDK (الإصدار الجديد).
  • التطبيقات الخاصة أو التجريبية إذا لم يكن تطبيقك متاحًا للجميع، لن تحتاج إلى استخدام ميزة "فحص التطبيقات".
  • إذا كان تطبيقك يُستخدَم فقط من خادم إلى خادم، لن تحتاج إلى ميزة "فحص التطبيقات". ومع ذلك، إذا كان الخادم الذي يتصل بـ GMP يُستخدم من قِبل عملاء متاحين للجميع (مثل التطبيقات المتوافقة مع الأجهزة الجوّالة)، ننصحك باستخدام ميزة "فحص التطبيقات" لحماية هذا الخادم بدلاً من GMP.

نظرة عامة على خطوات التنفيذ

في ما يلي الخطوات التي يجب اتّباعها لدمج تطبيقك مع ميزة "فحص التطبيقات":

  1. أضِف Firebase إلى تطبيقك.
  2. أضِف مكتبة فحص التطبيقات وابدأها.
  3. أضِف مقدّم الرمز المميّز إلى تطبيقك.
  4. ابدأ بإعداد واجهتَي Places API وواجهة برمجة تطبيقات فحص التطبيقات.
  5. فعِّل تصحيح الأخطاء.
  6. مراقبة طلبات تطبيقك واتّخاذ قرار بشأن إجراءات التنفيذ

بعد دمج تطبيقك مع ميزة "فحص التطبيقات"، ستتمكّن من الاطّلاع على مقاييس زيارات الخلفية في وحدة تحكُّم Firebase. توفّر هذه المقاييس تفاصيل الطلبات حسب ما إذا كانت مصحوبة برمز مميّز صالح لميزة "التحقّق من التطبيق". لمزيد من المعلومات، يمكنك الاطّلاع على مستندات ميزة "فحص التطبيقات من Firebase".

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

الاعتبارات الواجب مراعاتها عند التخطيط لدمج ميزة "فحص التطبيقات"

في ما يلي بعض النقاط التي يجب مراعاتها أثناء التخطيط لعملية الدمج:

  • يفرض أحد مقدّمي خدمات المصادقة الذين ننصح بهم، وهو reCAPTCHA Enterprise، رسومًا على أكثر من 10,000 تقييم شهريًا.

    يتم تحديد حصة لمزوّد خدمة المصادقة الآخر الذي ننصح به، وهو الإصدار الثالث من خدمة reCAPTCHA، ولن يتم تقييم الزيارات بعد بلوغ هذه الحصة.

    يمكنك اختيار استخدام مقدّم خدمة مصادقة مخصّص، مع العلم أنّ هذه حالة استخدام متقدّمة. لمزيد من المعلومات، يُرجى الاطّلاع على مستندات ميزة "فحص التطبيقات".

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

    يحدّد مقدار الوقت الذي يكون فيه رمز "فحص التطبيقات" صالحًا (مدة البقاء أو TTL) معدّل تكرار عمليات إعادة المصادقة. ويمكن ضبط هذه المدة في وحدة تحكُّم Firebase. تحدث إعادة المصادقة عند انقضاء نصف مدة TTL تقريبًا. لمزيد من المعلومات، يُرجى الاطّلاع على مستندات Firebase الخاصة بموفّر خدمة المصادقة.

دمج تطبيقك مع ميزة "فحص التطبيقات"

المتطلبات الأساسية والمتطلبات

  • تطبيق تم تحميل أحدث إصدار أسبوعي أو ربع سنوي من Maps JS API ومكتبتَي Core وPlaces فيه
  • مشروع على السحابة الإلكترونية تم فيه تفعيل واجهتَي برمجة التطبيقات Maps JS وPlaces API (الإصدار الجديد)
  • يجب أن تكون مالك التطبيق في Cloud Console.
  • ستحتاج إلى رقم تعريف مشروع التطبيق من Cloud Console

الخطوة 1: إضافة Firebase إلى تطبيقك

اتّبِع التعليمات الواردة في مستندات مطوّري Firebase لإضافة Firebase إلى تطبيقك.

الخطوة 2: إضافة مكتبة فحص التطبيقات وإعداد فحص التطبيقات

يوفّر Firebase تعليمات لكل مزوّد خدمة مصادقة تلقائي. توضّح لك هذه التعليمات كيفية إعداد مشروع Firebase وإضافة مكتبة فحص التطبيقات إلى تطبيقك. اتّبِع عيّنات التعليمات البرمجية المقدَّمة لإعداد فحص التطبيقات.

الخطوة 3: تحميل مكتبات Maps JS API

  1. حمِّل مكتبات core وMaps وPlaces كما هو موضّح في المقتطف التالي. لمزيد من المعلومات والتعليمات، يُرجى الاطّلاع على مستندات فئة المكان في Maps JavaScript API. 

    async function init() {
  const {Settings} = await google.maps.importLibrary('core');
  const {Map} = await google.maps.importLibrary('maps');
  const {Place} = await google.maps.importLibrary('places');
}

الخطوة 4: إعداد واجهتَي برمجة التطبيقات Places API وApp Check API

  1. ابدأ إعداد ميزة "فحص التطبيقات" باستخدام الإعدادات المقدَّمة من وحدة تحكُّم Firebase.
  2. تأكَّد من أنّ الطلبات المرسَلة إلى Maps JS API تتضمّن رموز فحص التطبيقات المميّزة: 
      async function init() {
    const {Settings} = await google.maps.importLibrary('core');
    const {Map} = await google.maps.importLibrary('maps');
    const {Place} = await google.maps.importLibrary('places');
  
    const app = initializeApp({
      // Your firebase configuration object
    });
  
    // Pass your reCAPTCHA Enterprise site key to initializeAppCheck().
    const appCheck = initializeAppCheck(app, {
      provider: new ReCaptchaEnterpriseProvider(
        'abcdefghijklmnopqrstuvwxy-1234567890abcd',
      ),
  
      // Optional argument. If true, the SDK automatically refreshes App Check
      // tokens as needed.
      isTokenAutoRefreshEnabled: true,
    });
  
    Settings.getInstance().fetchAppCheckToken = () =>
        getToken(appCheck, /* forceRefresh = */ false);
  
    // Make a Places JS request
    const place = new Place({id: 'ChIJN5Nz71W3j4ARhx5bwpTQEGg'});
    await place.fetchFields({fields: ['*']});
  
    // Load a map
    map = new Map(document.getElementById("map"), {
      center: { lat: 37.4161493, lng: -122.0812166 },
      zoom: 8,
    });
  }

الخطوة 5: تفعيل تصحيح الأخطاء (اختياري)

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

لاختبار تطبيقك محليًا:

  • فعِّل مقدّم خدمة تصحيح الأخطاء لأغراض التطوير.
  • ستتلقّى معرّف UUID4 عشوائيًا يتم إنشاؤه تلقائيًا (يُعرف باسم _رمز تصحيح الأخطاء_ في مستندات فحص التطبيقات) من سجلّات تصحيح الأخطاء في حزمة تطوير البرامج (SDK). أضِف هذا الرمز المميّز إلى وحدة تحكُّم Firebase.
  • لمزيد من المعلومات والتعليمات، يُرجى الاطّلاع على مستندات فحص التطبيقات.

لتشغيل تطبيقك في بيئة تكامل مستمر، اتّبِع الخطوات التالية:

  • أنشِئ معرّف UUID4 عشوائيًا من وحدة تحكُّم Firebase.
  • أضِف معرّف UUID4 كرمز تصحيح أخطاء، ثم انسخه إلى مخزن سري يمكن لاختبارات CI الوصول إليه لكل عملية اختبار.
  • لمزيد من المعلومات والتعليمات، يُرجى الاطّلاع على مستندات فحص التطبيقات.

الخطوة 6: مراقبة طلبات تطبيقك واتّخاذ قرار بشأن إجراءات التنفيذ

قبل بدء إجراءات التنفيذ، عليك التأكّد من أنّك لن تمنع المستخدمين الشرعيين من استخدام تطبيقك. ولإجراء ذلك، انتقِل إلى شاشة مقاييس "فحص التطبيقات" لمعرفة النسبة المئوية لعدد الزيارات التي تم التحقّق منها أو القديمة أو غير الشرعية في تطبيقك. بعد التأكّد من صحة معظم الزيارات، يمكنك تفعيل إجراءات التنفيذ.

لمزيد من المعلومات والتعليمات، يُرجى الاطّلاع على مستندات ميزة "فحص التطبيقات من Firebase".