JavaScript Auxiliar de autenticação - Amazon Location Service
Funções de autenticação

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

JavaScript Auxiliar de autenticação

O assistente de JavaScript autenticação de localização da Amazon simplifica a autenticação ao fazer API chamadas de localização da Amazon a partir do seu aplicativo. JavaScript Esse auxiliar de autenticação ajuda você especificamente ao usar o Amazon Cognito APIou as chaves como método de autenticação. Esta é uma biblioteca de código aberto que está disponível aqui: https://github.com/aws-geospatial/amazon-location-utilities-auth-helper-js. GitHub

nota

O suporte ao Amazon Cognito no auxiliar de autenticação não oferece suporte ao atributo de identidades federadas do Amazon Cognito.

Instalação

Você pode usar as bibliotecas com uma instalação local, se usar um sistema de compilação como o webpack, ou incluindo JavaScript pacotes pré-construídos com <script> tags em seu html.

  • Use o comando a seguir para instalar a biblioteca, usandoNPM:

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

  • Use o seguinte comando em seu HTML arquivo para carregar o script:

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

Importar

Para usar uma função específica em seu JavaScript aplicativo, você deve importar essa função. O código a seguir é usado para importar a função withIdentityPoolId para seu aplicativo.

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

Funções de autenticação

Os auxiliares de autenticação de localização da Amazon incluem as seguintes funções que retornam um objeto AuthHelper:

  • async withIdentityPoolId( identityPoolId: string): AuthHelper— Essa função retorna um AuthHelper objeto, inicializado para funcionar com o Amazon Cognito

  • async withAPIKey( API_KEY: string): AuthHelper— Essa função retorna um AuthHelper objeto, inicializado para funcionar com API chaves.

O objeto AuthHelper fornece as seguintes funções:

  • AuthHelper.getMapAuthenticationOptions()— Essa função do AuthHelper objeto retorna um JavaScript objeto com o transformRequest que pode ser usado com as opções de mapa em MapLibre JS. Fornecido somente quando inicializado com um banco de identidades.

  • AuthHelper.getLocationClientConfig()— Essa função do AuthHelper objeto retorna um JavaScript objeto com o credentials que pode ser usado para inicializar um LocationClient.

  • AuthHelper.getCredentials()— Essa função do AuthHelper objeto retorna as credenciais internas do Amazon Cognito. Fornecido somente quando inicializado com um banco de identidades.

Exemplo: inicializando um objeto de MapLibre mapa com o Amazon Cognito, usando um 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
});

Exemplo: inicializar o objeto do MapLibre mapa com uma API chave (não AuthHelper é necessário neste caso)

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

Exemplo: inicialize o cliente Location a partir do AWS SDK for JS, usando o Amazon Cognito e AuthHelper

Este exemplo usa AWS SDK para 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
});

Exemplo: inicialize o cliente Location a partir do AWS SDK for JS, usando uma API chave e AuthHelper

Este exemplo usa AWS SDK para 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
});