JavaScript Consumer SDK सेट अप करना

JavaScript Consumer SDK टूल की मदद से, आपका उपभोक्ता ऐप्लिकेशन, वेब-आधारित मैप पर वाहनों की जगह और Fleet Engine में ट्रैक की गई अन्य जगहों की जानकारी दिखा सकता है. इससे आपके उपभोक्ता, शिपमेंट की स्थिति देख सकते हैं. इस गाइड में यह माना गया है कि आपने Fleet Engine को, उससे जुड़े Google Cloud प्रोजेक्ट और एपीआई कुंजियों के साथ सेट अप किया है. ज़्यादा जानकारी के लिए, फ़्लीट इंजन देखें.

JavaScript Consumer SDK को सेट अप करने के लिए, यह तरीका अपनाएं:

  1. Maps JavaScript API को चालू करें.
  2. अनुमति सेट अप करना.

Maps JavaScript API चालू करना

उस Google Cloud Console प्रोजेक्ट में Maps JavaScript API को चालू करें जिसका इस्तेमाल आपने अपने Fleet Engine इंस्टेंस के लिए किया है. ज़्यादा जानकारी के लिए, Maps JavaScript API के दस्तावेज़ में एपीआई चालू करें देखें.

अनुमति सेट अप करना

कम भरोसेमंद एनवायरमेंट से एपीआई के तरीके के कॉल के लिए, Fleet Engine को JSON वेब टोकन (JWT) का इस्तेमाल करना होगा. इन टोकन पर, किसी सही सेवा खाते से हस्ताक्षर किया जाना चाहिए. कम भरोसेमंद प्लैटफ़ॉर्म में स्मार्टफ़ोन और ब्राउज़र शामिल हैं. JWT आपके सर्वर से जनरेट होता है, जो पूरी तरह भरोसेमंद एनवायरमेंट होता है. JWT पर हस्ताक्षर किया जाता है, उसे एन्क्रिप्ट किया जाता है, और उसे क्लाइंट को भेजा जाता है, ताकि वह सर्वर के साथ आगे के इंटरैक्शन के लिए इस्तेमाल किया जा सके. ऐसा तब तक किया जाता है, जब तक उसकी समयसीमा खत्म नहीं हो जाती या वह अमान्य नहीं हो जाता.

आपके बैकएंड को ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल के स्टैंडर्ड तरीके का इस्तेमाल करके, Fleet Engine की पुष्टि करनी चाहिए और उसे अनुमति देनी चाहिए. पक्का करें कि आपने ऐसे JWT का इस्तेमाल किया हो जिन पर किसी मान्य सेवा खाते से हस्ताक्षर किया गया हो. सेवा खाते की भूमिकाओं की सूची के लिए, Fleet Engine की बुनियादी बातें में Fleet Engine के सेवा खाते की भूमिकाएं देखें.

आपका उपभोक्ता ऐप्लिकेशन, आपके Google Cloud प्रोजेक्ट की delivery_consumer भूमिका के साथ, आपके असली उपयोगकर्ताओं की पुष्टि करेगा. इससे, सिर्फ़ उपभोक्ता से जुड़ी जानकारी दिखेगी. इस तरह, Fleet Engine जवाबों में मौजूद अन्य जानकारी को फ़िल्टर करता है और उसे छिपाता है. उदाहरण के लिए, किसी टास्क के उपलब्ध न होने पर, असली उपयोगकर्ता के साथ जगह की जानकारी शेयर नहीं की जाती. शेड्यूल किए गए टास्क के लिए, सेवा खाते की भूमिकाएं देखें.

इसके उलट, आपके बैकएंड को ऐप्लिकेशन के डिफ़ॉल्ट क्रेडेंशियल के मानक तरीकों का इस्तेमाल करके, Fleet Engine के लिए पुष्टि करनी चाहिए और अनुमति देनी चाहिए.

अनुमति देने की प्रोसेस कैसे काम करती है?

Fleet Engine के डेटा के लिए अनुमति देने की प्रोसेस, सर्वर साइड और क्लाइंट-साइड, दोनों पर लागू होती है.

सर्वर-साइड से अनुमति पाना

वेब-आधारित ऐप्लिकेशन में पुष्टि और अनुमति सेट अप करने से पहले, यह ज़रूरी है कि आपका बैकएंड सर्वर, Fleet Engine को ऐक्सेस करने के लिए, वेब-आधारित ऐप्लिकेशन को JSON वेब टोकन जारी कर सके. आपका वेब-आधारित ऐप्लिकेशन, अपने अनुरोधों के साथ ये JWT भेजता है, ताकि Fleet Engine यह पहचान सके कि अनुरोधों की पुष्टि हो चुकी है और उन्हें अनुरोध में मौजूद डेटा को ऐक्सेस करने की अनुमति है. सर्वर-साइड JWT लागू करने के निर्देशों के लिए, फ़्लीट इंजन की ज़रूरी जानकारी में जाकर, JSON वेब टोकन जारी करना देखें.

खास तौर पर, शिपमेंट ट्रैक करने के लिए JavaScript Consumer SDK टूल के लिए इन बातों का ध्यान रखें:

क्लाइंट-साइड अनुमति

JavaScript Consumer SDK का इस्तेमाल करने पर, यह ऑथराइज़ेशन टोकन फ़ेच करने वाले टूल का इस्तेमाल करके, सर्वर से टोकन का अनुरोध करता है. ऐसा तब होता है, जब इनमें से कोई भी शर्त पूरी हो:

  • कोई मान्य टोकन मौजूद नहीं है. जैसे, जब SDK टूल ने नए पेज लोड होने पर फ़ेचर को कॉल नहीं किया है या जब फ़ेचर ने टोकन नहीं दिया है.

  • टोकन की समयसीमा खत्म हो गई है.

  • टोकन की समयसीमा एक मिनट में खत्म होने वाली है.

ऐसा न करने पर, JavaScript Consumer SDK टूल, पहले जारी किए गए मान्य टोकन का इस्तेमाल करता है और फ़ेच करने वाले को कॉल नहीं करता.

अनुमति टोकन फ़ेच करने वाला टूल बनाना

इन दिशा-निर्देशों का इस्तेमाल करके, अनुमति वाला टोकन फ़ेच करने वाला टूल बनाएं:

  • फ़ेच करने वाले को दो फ़ील्ड वाला डेटा स्ट्रक्चर दिखाना चाहिए. इसे Promise में इस तरह लपेटा जाना चाहिए:

    • स्ट्रिंग token.

    • कोई नंबर expiresInSeconds. फ़ेच करने के बाद, टोकन की समयसीमा इस अवधि में खत्म हो जाती है. पुष्टि करने वाले टोकन को फ़ेच करने वाले को, लाइब्रेरी में फ़ेच करने के समय से लेकर खत्म होने के समय तक का समय सेकंड में देना होगा, जैसा कि उदाहरण में दिखाया गया है.

  • टोकन पाने के लिए, फ़ेच करने वाले टूल को आपके सर्वर पर मौजूद यूआरएल को कॉल करना चाहिए. यह यूआरएल--SERVER_TOKEN_URL--आपके बैकएंड के लागू होने पर निर्भर करता है. यहां दिया गया उदाहरण यूआरएल, GitHub पर मौजूद ऐप्लिकेशन के बैकएंड के सैंपल के लिए है:

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

उदाहरण - पुष्टि करने वाला टोकन फ़ेच करने वाला बनाना

नीचे दिए गए उदाहरणों में, अनुमति टोकन फ़ेच करने वाला फ़ंक्शन बनाने का तरीका बताया गया है:

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

आगे क्या करना है