إعداد "حزمة تطوير البرامج (SDK) للمستهلكين" بلغة JavaScript

باستخدام حزمة تطوير البرامج (SDK) لتطبيقات المستهلكين المستندة إلى JavaScript، يمكن لتطبيقك المخصّص للمستهلكين عرض الموقع الجغرافي للمركبات والمواقع الجغرافية الأخرى التي تهمّك والتي يتم تتبُّعها في Fleet Engine على ملف شخصي على الويب. يتيح ذلك للمستهلكين الاطّلاع على مستوى تقدّم شحناتهم. يفترض هذا الدليل أنّك قد أعددت Fleet Engine باستخدام مفتاحَي واجهة برمجة التطبيقات ومشروع Google Cloud المرتبطَين. راجِع Fleet Engine للاطّلاع على التفاصيل.

يمكنك إعداد حزمة تطوير البرامج (SDK) لإصدار JavaScript المخصّص للمستهلكين باتّباع الخطوات التالية:

1. فعِّل واجهة برمجة التطبيقات Maps JavaScript API.
2. إعداد التفويض

تفعيل Maps JavaScript API

فعِّل واجهة برمجة التطبيقات Maps JavaScript API في مشروع Google Cloud Console الذي تستخدمه لمثيل Fleet Engine. لمزيد من التفاصيل، يُرجى الاطّلاع على تفعيل واجهات برمجة التطبيقات في مستندات Maps JavaScript API.

إعداد التفويض

بالنسبة إلى طلبات بيانات واجهة برمجة التطبيقات من البيئات ذات مستوى الثقة المنخفض، تتطلّب أداة Fleet Engine استخدام رموز JSON المميّزة للويب (JWT) التي تم توقيعها من خلال حساب خدمة مناسب. وتشمل البيئات ذات الثقة المنخفضة الهواتف الذكية والمتصفّحات. يبدأ JWT على خادمك، وهو بيئة موثوق بها بالكامل. يتم توقيع ملف JWT وتشفيره ونقله إلى العميل للتفاعلات التالية مع الخادم إلى أن تنتهي صلاحيته أو يصبح غير صالح.

يجب أن تتم مصادقة الخلفية وتفويضها ضد Fleet Engine باستخدام آليات بيانات الاعتماد التلقائية للتطبيق العادية. احرص على استخدام ملفّات JWT التي تم توقيعها من خلال حساب خدمة مناسب. للاطّلاع على قائمة بأدوار حسابات الخدمة، راجِع أدوار حساب خدمة Fleet Engine في أساسيات Fleet Engine.

في المقابل، يجب أن تتم المصادقة والتفويض في الخلفية باستخدام بيانات الاعتماد التلقائية للتطبيق المعمول بها في Fleet Engine.

كيف يعمل التفويض؟

يشمل التفويض باستخدام بيانات Fleet Engine تنفيذًا من جهة العميل والخادم معًا.

التفويض من جهة الخادم

قبل إعداد المصادقة والتفويض في تطبيقك المستند إلى الويب، يجب أن يكون خادم الخلفية قادرًا على إصدار رموز الويب المميّزة بتنسيق JSON إلى تطبيقك المستند إلى الويب للوصول إلى Fleet Engine. يُرسِل تطبيقك المستنِد إلى الويب ملفّات JWT هذه مع طلباته حتى يتعرّف Fleet Engine على الطلبات على أنّها مُعتمَدة ومفوَّضة بالوصول إلى البيانات الواردة في الطلب. للحصول على تعليمات حول تنفيذ JWT من جهة الخادم، اطّلِع على إصدار رموّز الويب المميّزة JSON ضمن أساسيات Fleet Engine.

• الإرشادات العامة لإصدار الرموز المميّزة للويب بتنسيق JSON
• إرشادات JWT للمهام المُجدوَلة
• مثال على رمز مميّز لتطبيق مخصّص للمستهلكين

التفويض من جهة العميل

عند استخدام حزمة تطوير البرامج (SDK) للمستهلك المستندة إلى JavaScript، تطلب الحزمة رمزًا مميّزًا من الخادم باستخدام معالج جلب رمز التفويض. ويتم ذلك عند استيفاء أيٍّ ممّا يلي:

• لا يتوفّر رمز مميّز صالح، مثلما يحدث عندما لا تستدعي حزمة تطوير البرامج (SDK) أداة الجلب عند تحميل صفحة جديدة، أو عندما لا تُرجع أداة الجلب رمزًا مميّزًا.

• انتهت صلاحية الرمز المميّز.

• ستنتهي صلاحية الرمز المميّز خلال دقيقة واحدة.

بخلاف ذلك، تستخدم حزمة JavaScript Consumer SDK الرمز المميّز الصالح الذي تم إصداره سابقًا ولا تستدعي أداة الجلب.

إنشاء أداة جلب رمز مميّز لمنح الأذونات

أنشئ أداة جلب رمز التفويض باستخدام الإرشادات التالية:

• يجب أن يعرض أداة الجلب بنية بيانات تتضمّن حقلَين، يتم تضمينهما في علامة Promise على النحو التالي:

  • سلسلة token.

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

• يجب أن يطلب أداة الجلب عنوان URL على خادمك لاسترداد رمز مميّز. يعتمد عنوان URL هذا، أي SERVER_TOKEN_URL، على عملية التنفيذ في الخلفية. المثال التالي على عنوان URL مخصّص لنموذج الخلفية للتطبيق على GitHub:

  • https://SERVER_URL/token/delivery_consumer/TRACKING_ID

مثال: إنشاء أداة جلب رمز مميّز للمصادقة

توضِّح الأمثلة التالية كيفية إنشاء أداة جلب رمز مميّز للتفويض:

async function authTokenFetcher(options) {
  // options is a record containing two keys called
  // serviceType and context. The developer should
  // generate the correct SERVER_TOKEN_URL and request
  // based on the values of these fields.
  const response = await fetch(SERVER_TOKEN_URL);
  if (!response.ok) {
    throw new Error(response.statusText);
  }
  const data = await response.json();
  return {
    token: data.Token,
    expiresInSeconds: data.ExpiresInSeconds
  };
}

function authTokenFetcher(options: {
  serviceType: google.maps.journeySharing.FleetEngineServiceType,
  context: google.maps.journeySharing.AuthTokenContext,
}): Promise<google.maps.journeySharing.AuthToken> {
  // The developer should generate the correct
  // SERVER_TOKEN_URL based on options.
  const response = await fetch(SERVER_TOKEN_URL);
  if (!response.ok) {
    throw new Error(response.statusText);
  }
  const data = await response.json();
  return {
    token: data.token,
    expiresInSeconds: data.ExpiresInSeconds,
  };
}

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

• متابعة شحنة