JavaScript Aiutante di autenticazione - Servizio di posizione Amazon
Funzioni di autenticazione

Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

JavaScript Aiutante di autenticazione

L'helper di JavaScript autenticazione Amazon Location semplifica l'autenticazione quando effettui API chiamate Amazon Location dalla tua applicazione. JavaScript Questo assistente di autenticazione ti aiuta specificamente a utilizzare Amazon Cognito APIo le chiavi come metodo di autenticazione. Questa è una libreria open source disponibile qui: GitHub https://github.com/aws-geospatial/ amazon-location-utilities-auth -helper-js.

Nota

Il supporto di Amazon Cognito nell'helper di autenticazione non supporta la funzionalità di identità federate di Amazon Cognito.

Installazione

Puoi usare le librerie con un'installazione locale, se usi un sistema di compilazione come webpack, o includendo JavaScript pacchetti predefiniti con <script> tag nel tuo html.

  • Usa il seguente comando per installare la libreria, usando: NPM

    npm install @aws/amazon-location-utilities-auth-helper

  • Utilizzate il seguente comando nel HTML file per caricare lo script:

    <script src="https://unpkg.com/@aws/amazon-location-utilities-auth-helper@1.x/dist/amazonLocationAuthHelper.js"></script>

Importa

Per utilizzare una funzione specifica nell' JavaScript applicazione, è necessario importare tale funzione. Il codice seguente viene utilizzato per importare la funzione withIdentityPoolId nell'applicazione.

import { withIdentityPoolId } from '@aws/amazon-location-utilities-auth-helper';

Funzioni di autenticazione

Gli helper di autenticazione di Amazon Location includono le seguenti funzioni che restituiscono un AuthHelper oggetto:

  • async withIdentityPoolId( identityPoolId: string): AuthHelper— Questa funzione restituisce un AuthHelper oggetto, inizializzato per funzionare con Amazon Cognito

  • async withAPIKey( API_KEY: string): AuthHelper— Questa funzione restituisce un AuthHelper oggetto, inizializzato per funzionare con Keys. API

L'AuthHelperoggetto fornisce le seguenti funzioni:

  • AuthHelper.getMapAuthenticationOptions()— Questa funzione dell' AuthHelper oggetto restituisce un JavaScript oggetto con le opzioni della mappa transformRequest che può essere utilizzato con le opzioni della mappa in MapLibre JS. Fornito solo se inizializzato con un pool di identità.

  • AuthHelper.getLocationClientConfig()— Questa funzione dell' AuthHelper oggetto restituisce un JavaScript oggetto con il credentials quale è possibile inizializzare un. LocationClient

  • AuthHelper.getCredentials()— Questa funzione dell' AuthHelper oggetto restituisce le credenziali interne di Amazon Cognito. Fornito solo se inizializzato con un pool di identità.

Esempio: inizializzazione di un oggetto MapLibre mappa con Amazon Cognito, utilizzando un AuthHelper

import { withIdentityPoolId } from '@aws/amazon-location-utilities-auth-helper';

const authHelper = await withIdentityPoolId("identity-pool-id"); // use Cognito pool id for credentials

const map = new maplibregl.Map({
    container: "map", // HTML element ID of map element
    center: [-123.1187, 49.2819], // initial map center point
    zoom: 16, // initial map zoom
    style: https://maps.geo.region.amazonaws.com/maps/v0/maps/mapName/style-descriptor', // Defines the appearance of the map
    ...authHelper.getMapAuthenticationOptions(), // Provides credential options required for requests to Amazon Location
});

Esempio: inizializzazione dell'oggetto della MapLibre mappa con una API chiave (in questo caso non AuthHelper è necessaria)

const map = new maplibregl.Map({
    container: "map", // HTML element ID of map element
    center: [-123.1187, 49.2819], // initial map center point
    zoom: 16, // initial map zoom
    style: https://maps.geo.region.amazonaws.com/maps/v0/maps/${mapName}/style-descriptor?key=api-key-id',
});

Esempio: inizializza il client Location da AWS SDK for JS, utilizzando Amazon Cognito e AuthHelper

Questo esempio utilizza AWS SDK for JavaScript v3.

import { withIdentityPoolId } from '@aws/amazon-location-utilities-auth-helper';

const authHelper = await withIdentityPoolId("identity-pool-id"); // use Cognito pool id for credentials

//initialize the Location client:
const client = new LocationClient({
    region: "region",
    ...authHelper.getLocationClientConfig() // sets up the Location client to use the Cognito pool defined above
});

//call a search function with the location client:
const result = await client.send(new SearchPlaceIndexForPositionCommand({
    IndexName: "place-index", // Place index resource to use
    Position: [-123.1187, 49.2819], // position to search near
    MaxResults: 10 // number of results to return
});

Esempio: inizializza il client Location da AWS SDK for JS, utilizzando una chiave e API AuthHelper

Questo esempio utilizza AWS SDK for JavaScript v3.

import { withAPIKey } from '@aws/amazon-location-utilities-auth-helper';

const authHelper = await withAPIKey("api-key-id"); // use API Key id for credentials

//initialize the Location client:
const client = new LocationClient({
    region: "region",
    ...authHelper.getLocationClientConfig() // sets up the Location client to use the API Key defined above
});

//call a search function with the location client:
const result = await client.send(new SearchPlaceIndexForPositionCommand({
    IndexName: "place-index", // Place index resource to use
    Position: [-123.1187, 49.2819], // position to search near
    MaxResults: 10 // number of results to return
});