JavaScript Authentifizierungshelfer - Amazon Location Service
Funktionen zur Authentifizierung

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

JavaScript Authentifizierungshelfer

Der Amazon JavaScript Location-Authentifizierungshelfer erleichtert die Authentifizierung, wenn Sie Amazon API Location-Anrufe von Ihrer JavaScript Anwendung aus tätigen. Dieser Authentifizierungshelfer hilft Ihnen speziell bei der Verwendung von Amazon Cognito oder APIKeys als Authentifizierungsmethode. Dies ist eine Open-Source-Bibliothek, die hier verfügbar ist: GitHub https://github.com/aws-geospatial/amazon-location-utilities-auth-helper-js.

Anmerkung

Die Amazon Cognito-Unterstützung im Authentifizierungshelfer unterstützt die Funktion für föderierte Identitäten von Amazon Cognito nicht.

Installation

Sie können die Bibliotheken mit einer lokalen Installation verwenden, wenn Sie ein Build-System wie Webpack verwenden, oder indem Sie vorgefertigte JavaScript Bundles mit <script> Tags in Ihr HTML aufnehmen.

  • Verwenden Sie den folgenden Befehl, um die Bibliothek zu installieren, und zwar mit: NPM

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

  • Verwenden Sie den folgenden Befehl in Ihrer HTML Datei, um das Skript zu laden:

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

Import

Um eine bestimmte Funktion in Ihrer JavaScript Anwendung zu verwenden, müssen Sie diese Funktion importieren. Der folgende Code wird verwendet, um die Funktion withIdentityPoolId in Ihre Anwendung zu importieren.

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

Funktionen zur Authentifizierung

Die Amazon Location-Authentifizierungshelfer umfassen die folgenden Funktionen, die ein AuthHelper Objekt zurückgeben:

  • async withIdentityPoolId( identityPoolId: string): AuthHelper— Diese Funktion gibt ein AuthHelper Objekt zurück, das für die Verwendung mit Amazon Cognito initialisiert wurde

  • async withAPIKey( API_KEY: string): AuthHelper— Diese Funktion gibt ein AuthHelper Objekt zurück, das für die Verwendung mit Schlüsseln initialisiert wurde. API

Das AuthHelper Objekt bietet die folgenden Funktionen:

  • AuthHelper.getMapAuthenticationOptions()— Diese Funktion des AuthHelper Objekts gibt ein JavaScript Objekt mit dem zurücktransformRequest, das mit den Map-Optionen in MapLibre JS verwendet werden kann. Wird nur bereitgestellt, wenn es mit einem Identitätspool initialisiert wurde.

  • AuthHelper.getLocationClientConfig()— Diese Funktion des AuthHelper Objekts gibt ein JavaScript Objekt mit dem zurückcredentials, das zur Initialisierung eines verwendet werden kann. LocationClient

  • AuthHelper.getCredentials()— Diese Funktion des AuthHelper Objekts gibt die internen Anmeldeinformationen von Amazon Cognito zurück. Wird nur bereitgestellt, wenn es mit einem Identitätspool initialisiert wurde.

Beispiel: Initialisieren eines MapLibre Kartenobjekts mit Amazon Cognito unter Verwendung eines 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
});

Beispiel: Initialisieren des MapLibre Kartenobjekts mit einem API Schlüssel (AuthHelperist in diesem Fall nicht erforderlich)

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

Beispiel: Initialisieren Sie den Location-Client aus dem AWS SDK for JS mithilfe von Amazon Cognito und AuthHelper

Dieses Beispiel verwendet AWS SDK für 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
});

Beispiel: Initialisieren Sie den Location-Client von AWS SDK for JS aus mit einem API Schlüssel und AuthHelper

Dieses Beispiel verwendet AWS SDK für 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
});