Auktorisation: ApiKey, användaruppgifter eller OAuth 2.0

GeoPard-lösningen använder AWS Cognito för autentiseringsproceduren.

Vi rekommenderar att kontrollera alla auktoriseringsalternativ. Valet beror på det specifika användningsfallet. Mer användningsdetaljer beskrivs i varje alternativ nedan.

Alternativ 1: Använda referenser

Auktorisering med ”användarnamn” och ”lösenord” är en av de möjliga metoderna. I detta fall måste e-postregistrering göras (inte via sociala nätverk).

Tillvägagångssättet rekommenderas för integration på API (BackEnd)-nivå och alla förfrågningar till GeoPard API proxas via en dedikerad specialtjänst (mikrotjänst).

Inloggningsförfrågan

curl --location --request POST 'https://api.geopard.tech/login' \
--header 'Content-Type: application/json' \
--header 'Content-Type: text/plain' \
--data-raw '{"username":"<email_address>","password":"<password>"}'

Inloggningssvar

Token är en JWT med en livslängd på 30 minuter. Det är bästa praxis att lagra en enda token och återanvända den i alla förfrågningar, kontrollera dess utgångstid och hämta en ny token när den löper ut (eller strax innan).

{
    "token": "<token_to_use_in_geopard_api>"
}

Alternativ 2: OAuth 2.0

AWS Cognito stöder OAuth 2.0-protokollet för auktorisering. En allmän översikt beskrivs i artikeln Cognito OAuth2-handbok, underartikeln Authorization Code Grant är mest intressant i GeoPard-fallet.

Tillvägagångssättet rekommenderas för att integrera GeoPard på användargränssnittet (FrontEnd)-nivå. Integrationen fungerar i båda riktningarna för att skicka/motta data till/från GeoPard.

Kortfattat:

1. Din applikation måste omdirigera en användare till GeoPard Cognito för inloggning eller registrering.

Exempel:

curl --location --request GET '
https://auth.geopard.tech/oauth2/authorize?response_type=code&client_id=<connect_geopard_team>&redirect_uri=http://localhost:8080&state=54321
'

Vänligen kontakta GeoPard-teamet för att få din applikations individuella client_id.

1. Den omdirigerade URL:en kommer att ta emot en verifierings kod för nästa steg.

Den omdirigerade URL:en ser ut som http://localhost:8080/?code=eb10956a-6d51-49e5-bbfe-9815e3fdc70a&state=54321.

1. Din applikation måste byta ut kod för tokens (access_token, refresh_token, id_token).

Exempel:

curl --location --request POST '
https://auth.geopard.tech/oauth2/token
' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cookie: XSRF-TOKEN=365e14e1-3c66-477e-b0ef-a9e436a834ee; csrf-state=""; csrf-state-legacy=""' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'code=eb10956a-6d51-49e5-bbfe-9815e3fdc70a' \
--data-urlencode 'client_id=42ajne9u466in6gaf569nth9o9' \
--data-urlencode 'redirect_uri=
http://localhost:8080
'

Alternativ 3: API-nyckel

Snabb åtkomst till WMS och WFS är ibland nödvändig. Därför är det möjligt att använda GeoPards API-nyckel som automatiskt genereras för varje konto.

API-nyckeln finns i apiKey attributet i GraphQL-entiteten "UserData". Instruktioner om hur man hämtar apiKey ges HÄR.

apiKey måste användas med /geo endpoints ENDAST.

Användning:

1. Som en geopardApiKey parameter i GET-förfrågans URL.

2. Som en X-API-Key header i VALFRI förfrågan.