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

لاستخدام واجهة برمجة التطبيقات Google Awareness API، يجب إضافة مفتاح واجهة برمجة تطبيقات Google إلى تطبيقك. ونوع مفتاح واجهة برمجة التطبيقات الذي تحتاجه هو مفتاح واجهة برمجة تطبيقات Android.

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

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

يجب اتّباع عدة خطوات للحصول على مفتاح لتطبيقك. يتم وصف هذه الخطوات بالتفصيل في هذا الدليل، ويتم تلخيصها على النحو التالي:

  1. الحصول على معلومات عن شهادة تطبيقك
  2. تسجيل مشروع في Google Developers console وإضافة User Context API كخدمة للمشروع
  3. طلب مفتاح
  4. إضافة المفتاح إلى تطبيقك: للقيام بذلك، أضِف عنصرًا إلى بيان تطبيقك.

العثور على معلومات شهادة تطبيقك

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

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

لمزيد من المعلومات عن keytool، اطّلِع على مستندات Oracle.

شهادة تصحيح الأخطاء

عرض الملف المرجعي لشهادة تصحيح الأخطاء

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

  1. حدِّد موقع ملف ملف تخزين المفاتيح لتصحيح الأخطاء. اسم الملف هو debug.keystore، ويتم إنشاؤه في المرة الأولى التي تنشئ فيها مشروعك. يتم تخزينه تلقائيًا في الدليل نفسه الذي يتم فيه تخزين ملفات "جهاز Android الافتراضي" (AVD):

    • نظام التشغيل OS X وLinux: ~/.android/
    • نظام التشغيل Windows Vista وWindows 7: C:\Users\your_user_name\.android\

  2. اعرض الملف المرجعي SHA-1:

    • بالنسبة إلى Linux أو OS X، افتح نافذة محطة طرفية وأدخِل ما يلي:

      keytool -list -v -keystore ~/.android/debug.keystore -alias androiddebugkey -storepass android -keypass android

    • بالنسبة إلى Windows Vista وWindows 7، شغِّل ما يلي:

      keytool -list -v -keystore "%USERPROFILE%\.android\debug.keystore" -alias androiddebugkey -storepass android -keypass android

ينبغي أن تظهر مُخرجات مشابهة لما يلي:

Alias name: androiddebugkey
Creation date: Jan 01, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4aa9b300
Valid from: Mon Jan 01 08:04:04 UTC 2013 until: Mon Jan 01 18:04:04 PST 2033
Certificate fingerprints:
     MD5:  AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6A:AC:F9
     SHA1: BB:0D:AC:74:D3:21:E1:43:07:71:9B:62:90:AF:A1:66:6E:44:5D:75
     Signature algorithm name: SHA1withRSA
     Version: 3
شهادة الإصدار

عرض الملف المرجعي لشهادة الإصدار

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

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

  2. أدخِل ما يلي لعرض الأسماء المستعارة لجميع المفاتيح في ملف تخزين المفاتيح:

    keytool -list -keystore your_keystore_name
  3. استبدِل your_keystore_name بالمسار المؤهّل بالكامل واسم ملف تخزين المفاتيح. أضِف الامتداد ‎.keystore. أدخِل كلمة مرور ملف تخزين المفاتيح عندما يُطلب منك ذلك. بعد ذلك، keytool يعرض جميع الأسماء المستعارة في ملف تخزين المفاتيح.

  4. أدخِل ما يلي في محطة طرفية أو موجّه الأوامر:

          keytool -list -v -keystore your_keystore_name -alias your_alias_name
  5. استبدِل your_keystore_name بالمسار المؤهّل بالكامل واسم ملف تخزين المفاتيح. أضِف الامتداد .keystore.
  6. استبدِل your_alias_name بالاسم المستعار الذي خصّصته للشهادة عند إنشائها.

ينبغي أن تظهر مُخرجات مشابهة لما يلي:

Alias name: <alias_name>
Creation date: Feb 02, 2013
Entry type: PrivateKeyEntry
Certificate chain length: 1
Certificate[1]:
Owner: CN=Android Debug, O=Android, C=US
Issuer: CN=Android Debug, O=Android, C=US
Serial number: 4cc9b300
Valid from: Mon Feb 02 08:01:04 UTC 2013 until: Mon Feb 02 18:05:04 PST 2033
Certificate fingerprints:
    MD5:  AE:9F:95:D0:A6:86:89:BC:A8:70:BA:34:FF:6B:AC:F9
    SHA1: BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:90:AF:A1:66:6E:44:5D:75
    Signature algorithm name: SHA1withRSA
    Version: 3

يحتوي السطر الذي يبدأ بـ SHA1 على الملف المرجعي SHA-1 للشهادة. الملف المرجعي هو سلسلة من 20 رقمًا سداسيًا مكوّنًا من رقمين مفصولَين بنقطتَين.

الحصول على مفتاح واجهة برمجة تطبيقات من Google Developers Console

للبدء في استخدام واجهة برمجة التطبيقات Google Awareness API، انقر على الزر الحصول على مفتاح. ينقلك هذا الزر إلى Google Developers Console، الذي يقدّم لك إرشادات خلال العملية ويُفعِّل واجهة برمجة التطبيقات Awareness API تلقائيًا.

الحصول على مفتاح

بدلاً من ذلك، اتّبِع الخطوات التالية للحصول على مفتاح واجهة برمجة تطبيقات:

  1. انتقِل إلى Google Developers Console.
  2. اختَر مشروعًا أو أنشئ مشروعًا جديدًا.
  3. انقر على متابعة لتفعيل واجهة برمجة التطبيقات Awareness API.

  4. في صفحة "بيانات الاعتماد"، أنشئ مفتاح Android واضبط بيانات اعتماد واجهة برمجة التطبيقات.

  5. في مربّع الحوار "إنشاء مفتاح"، عليك حصر استخدامك بتطبيقات Android. للقيام بذلك، أدخِل الملف المرجعي SHA-1 لتطبيقك واسم الحزمة، كما في المثال التالي:

    BB:0D:AC:74:D3:21:E1:43:67:71:9B:62:91:AF:A1:66:6E:44:5D:75

com.example.android.awareness-example

  6. انقر على إنشاء. يظهر مفتاح واجهة برمجة تطبيقات Android الجديد في قائمة مفاتيح واجهة برمجة التطبيقات لمشروعك. مفتاح واجهة برمجة التطبيقات هو سلسلة من الأحرف، مثل ما يلي:

    AIzaSyBdVl-cTICSwYKrZ95LoVuw7dbMuDt1KG0

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

تفعيل واجهات برمجة التطبيقات الإضافية

تتيح لك واجهة برمجة التطبيقات Awareness API الوصول إلى أنواع متعدّدة من البيانات السياقية، مثل المرشدين. لاستخدام هذه الأنواع، عليك تفعيل واجهات برمجة التطبيقات المقابلة في Google Developers Console.

الخدمة طُرق واجهة برمجة التطبيقات Awareness API واجهة برمجة التطبيقات التي يجب تفعيلها
المرشدون SnapshotApi.getBeaconState(), FenceApi.BeaconFence Nearby Messages API