הגדרת JavaScript Consumer SDK

באמצעות ה-SDK לצרכנים ב-JavaScript, אפליקציית הצרכנים יכולה להציג מפה מבוססת-אינטרנט עם המיקום של כלי הרכב ומיקומי עניין אחרים שבהם מתבצע מעקב ב-Fleet Engine. כך הצרכנים יוכלו לראות את ההתקדמות של המשלוח. במדריך הזה אנו מביאים בחשבון שכבר הגדרתם את Fleet Engine עם הפרויקט ועם מפתחות ה-API המשויכים שלו ב-Google Cloud. פרטים נוספים זמינים במאמר Fleet Engine.

כדי להגדיר את JavaScript Consumer SDK, צריך לבצע את השלבים הבאים:

1. מפעילים את Maps JavaScript API.
2. מגדירים הרשאה.

הפעלת Maps JavaScript API

מפעילים את Maps JavaScript API בפרויקט במסוף Google Cloud שבו אתם משתמשים למכונה של Fleet Engine. פרטים נוספים זמינים במאמר הפעלת ממשקי API במסמכי העזרה של Maps JavaScript API.

הגדרת הרשאה

לקריאות ל-method של API מסביבות עם רמת אמון נמוכה, ב-Fleet Engine צריך להשתמש ב-JSON Web Tokens (אסימוני JWT) חתומים על ידי חשבון שירות מתאים. סביבות עם רמת אמון נמוכה כוללות סמארטפונים ודפדפנים. JWT נוצר בשרת שלכם, שהוא סביבה מהימנה לחלוטין. ה-JWT נחתם, מוצפן ומוענק ללקוח לצורך אינטראקציות עתידיות עם השרת, עד שתוקף האסימון יפוג או שהוא כבר לא יהיה תקף.

הקצה העורפי צריך לבצע אימות והרשאה מול Fleet Engine באמצעות מנגנונים רגילים של Application Default Credentials. חשוב להשתמש באסימוני JWT שנחתמו על ידי חשבון שירות מתאים. לרשימת התפקידים של חשבונות השירות, ראו תפקידי חשבון השירות של Fleet Engine בקטע יסודות של Fleet Engine.

לעומת זאת, הקצה העורפי צריך לבצע אימות והרשאה מול Fleet Engine באמצעות מנגנונים רגילים של Application Default Credentials.

איך מתבצע האימות?

הרשאה עם נתוני Fleet Engine כוללת הטמעה גם בצד השרת וגם בצד הלקוח.

הרשאה בצד השרת

לפני שמגדירים אימות והרשאה באפליקציה מבוססת-האינטרנט, שרת הקצה העורפי צריך להיות מסוגל להנפיק לאפליקציה מבוססת-האינטרנט אסימוני אינטרנט מסוג JSON כדי לקבל גישה ל-Fleet Engine. האפליקציה מבוססת-האינטרנט שולחת את אסימוני ה-JWT האלה יחד עם הבקשות, כך ש-Fleet Engine מזהה את הבקשות כמאומתות ומורשה לגשת לנתונים שבבקשה. להוראות להטמעת JWT בצד השרת, אפשר לעיין בקטע הנפקה של אסימוני אינטרנט מסוג JSON בקטע יסודות של Fleet Engine.

• הנחיות כלליות להנפקה של אסימוני JSON Web
• הנחיות לשימוש ב-JWT במשימות מתוזמנות
• דוגמה לטוקן של אפליקציית צרכן

הרשאה מצד הלקוח

כשמשתמשים ב-SDK של צרכן JavaScript, הוא מבקש אסימון מהשרת באמצעות גורם לאחזור אסימוני הרשאה. היא עושה זאת כשמתקיים אחד מהתנאים הבאים:

• אין טוקן תקף, למשל כש-SDK לא קרא למאחזר בטעינה של דף חדש, או כשהמאחזר לא החזיר טוקן.

• פג תוקפו של הטוקן.

• תוקף האסימון יפוג תוך דקה.

אחרת, ה-SDK של צרכן JavaScript משתמש באסימון החוקי שהונפק בעבר ולא קורא למאחזר.

יצירת אובייקט לאחזור של אסימון הרשאה

יוצרים את האוסף של אסימוני ההרשאה לפי ההנחיות הבאות:

• המאחזר צריך להחזיר מבנה נתונים עם שני שדות, שמוקף ב-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,
  };
}

המאמרים הבאים

• מעקב אחרי משלוח