JavaScript Tüketici SDK'sını ayarlama

JavaScript Tüketici SDK'sı sayesinde tüketici uygulamanız, Fleet Engine'da izlenen araçların ve diğer ilgi çekici konumların konumunu web tabanlı bir haritada gösterebilir. Bu sayede tüketici kullanıcılarınız gönderimlerinin durumunu görebilir. Bu kılavuzda, Fleet Engine'ı ilişkili Google Cloud projesi ve API anahtarlarıyla oluşturduğunuz varsayılmaktadır. Ayrıntılar için Fleet Engine'e bakın.

JavaScript Tüketici SDK'sını aşağıdaki adımları uygulayarak kurarsınız:

  1. Maps JavaScript API'yi etkinleştirin.
  2. Yetkilendirmeyi ayarlayın.

Maps JavaScript API'yi etkinleştirme

Fleet Engine örneğiniz için kullandığınız Google Cloud Console projesinde Haritalar JavaScript API'yi etkinleştirin. Daha fazla bilgi için Maps JavaScript API belgelerindeki API'leri etkinleştirme bölümüne bakın.

Yetkilendirme kurulumu

Güvenilirliği düşük ortamlardan gelen API yöntemi çağrıları için Fleet Engine, uygun bir hizmet hesabı tarafından imzalanan JSON Web Jetonları'nın (JWT'ler) kullanılmasını gerektirir. Güven düzeyi düşük ortamlar arasında akıllı telefonlar ve tarayıcılar bulunur. JWT, tamamen güvenilir bir ortam olan sunucunuzda oluşturulur. JWT, süresi dolana veya geçerliliğini yitirene kadar imzalanır, şifrelenir ve sonraki sunucu etkileşimleri için istemciye iletilir.

Arka uçunuz, standart Uygulama Varsayılan Kimlik Bilgileri mekanizmalarını kullanarak Fleet Engine'da kimlik doğrulaması ve yetkilendirme yapmalıdır. Uygun bir hizmet hesabı tarafından imzalanmış JWT'leri kullandığınızdan emin olun. Hizmet hesabı rollerinin listesi için Fleet Engine'in Temel Özellikleri başlıklı makalenin Fleet Engine hizmet hesabı rolleri bölümüne bakın.

Tüketici uygulamanız, yalnızca tüketiciye özgü bilgileri döndürmek için son kullanıcılarınızın kimliğini Google Cloud projenizdeki delivery_consumer rolüyle doğrulamalıdır. Bu sayede Fleet Engine, yanıtlardaki diğer tüm bilgileri filtreler ve çıkartır. Örneğin, müsait olmama görevi sırasında son kullanıcıyla hiçbir konum bilgisi paylaşılmaz. Planlanmış görevler için Hizmet hesabı rolleri başlıklı makaleyi inceleyin.

Buna karşılık, arka uçunuz standart uygulama varsayılan kimlik bilgileri mekanizmalarını kullanarak Fleet Engine'e karşı kimlik doğrulaması ve yetkilendirme yapmalıdır.

Yetkilendirme nasıl çalışır?

Fleet Engine verileriyle yetkilendirme, hem sunucu hem de istemci taraflı uygulamayı içerir.

Sunucu tarafı yetkilendirme

Web tabanlı uygulamanızda kimlik doğrulama ve yetkilendirmeyi ayarlamadan önce arka uç sunucunuzun, Fleet Engine'a erişmek için web tabanlı uygulamanıza JSON Web Jetonu gönderebilmesi gerekir. Web tabanlı uygulamanız, bu JWT'leri istekleriyle birlikte gönderir. Böylece Fleet Engine, istekleri kimliği doğrulanmış ve istekteki verilere erişme yetkisine sahip olarak tanır. Sunucu tarafı JWT uygulamayla ilgili talimatlar için Fleet Engine'in Temel Özellikleri bölümündeki JSON Web Jetonu verme bölümüne bakın.

Özellikle, kargoları izlemek için JavaScript tüketici SDK'sı ile ilgili aşağıdakileri göz önünde bulundurun:

İstemci tarafı yetkilendirme

JavaScript Tüketici SDK'sını kullandığınızda, yetkilendirme jetonu alıcısını kullanarak sunucudan jeton ister. Bu işlem aşağıdakilerden biri geçerli olduğunda yapılır:

  • Geçerli bir jeton yok (ör. SDK yeni bir sayfa yüklendiğinde getirme işlevini çağırmadıysa veya getirme işlevi bir jetonla dönmediyse).

  • Jetonun süresi doldu.

  • Jetonun süresi bir dakika içinde dolacak.

Aksi takdirde JavaScript tüketici SDK'sı daha önce verilen geçerli jetonu kullanır ve getirme aracını çağırmaz.

Yetkilendirme jetonu getirme aracısı oluşturma

Yetkilendirme jetonu alıcınızı aşağıdaki yönergeleri kullanarak oluşturun:

  • Alıcılar, iki alan içeren bir veri yapısı döndürmelidir. Bu yapı, aşağıdaki gibi bir Promise içine sarılmalıdır:

    • Bir dize token.

    • expiresInSeconds numarası. Bir jetonun süresi, getirildikten sonra bu süre içinde dolar. Kimlik doğrulama jetonu getirme aracı, örnekte gösterildiği gibi kitaplığa getirme zamanından itibaren geçerlilik bitiş süresini saniye cinsinden iletmelidir.

  • Alıcının, jeton almak için sunucunuzdaki bir URL'yi çağırması gerekir. Bu URL (SERVER_TOKEN_URL), arka uç uygulamanıza bağlıdır. Aşağıdaki örnek URL, GitHub'daki örnek uygulama arka ucu içindir:

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

Örnek: Kimlik doğrulama jetonu getirme aracısı oluşturma

Aşağıdaki örneklerde, yetkilendirme jetonu getirme aracının nasıl oluşturulacağı gösterilmektedir:

JavaScript

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
  };
}

TypeScript

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,
  };
}

Sırada ne var?