Valtuutus: ApiKey, tunnistetiedot tai OAuth 2.0

GeoPard-ratkaisu käyttää AWS Cognitoa valtuutusprosessiin.

Suosittelemme tarkistamaan kaikki valtuutusvaihtoehdot. Valinta riippuu erityisestä käyttötapauksesta. Lisätietoja käytöstä on kuvattu kussakin alla olevassa vaihtoehdossa.

Vaihtoehto 1: Käyttäjätunnuksen ja salasanan käyttö

Valtuutus "käyttäjätunnus"- ja "salasana"-menetelmällä on yksi mahdollinen lähestymistapa. Tässä tapauksessa sähköpostirekisteröinti on tehtävä (ei sosiaalisen median kautta).

Lähestymistapaa suositellaan integroitavaksi API-tasolla (BackEnd) ja kaikki pyynnöt GeoPard-APIin välitetään omistetun erillisen palvelun (mikropalvelun) kautta.

Kirjautumispyyntö

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>"}'

Kirjautumisvastaus

Token on JWT, jonka voimassaoloaika on 30 minuuttia. Parhaana käytäntönä on tallentaa yksi token ja käyttää sitä kaikissa pyynnöissä, tarkistaen sen vanhenemisaika ja hakien uusi token vanhentumisen yhteydessä (tai hieman ennen sitä).

{
    "token": "<token_to_use_in_geopard_api>"
}

Vaihtoehto 2: OAuth 2.0

AWS Cognito tukee OAuth 2.0 -protokollaa valtuutukseen. Yleiskuvaus on kuvattu artikkelissa Cognito OAuth2 -opas, alakappaleessa Authorization Code Grant on GeoPard-tapauksessa mielenkiintoisin.

Lähestymistapaa suositellaan integroimaan GeoPard käyttöliittymätasolla (FrontEnd). Integraatio toimii molempiin suuntiin tietojen lähettämiseksi/vastaanottamiseksi GeoPardista/GeoPardiin.

Lyhyesti kerrottuna:

1. Sovelluksesi on ohjattava käyttäjä GeoPard Cognitoon kirjautumista tai rekisteröitymistä varten.

Esimerkki:

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
'

Ota yhteyttä GeoPard-tiimiin saadaksesi sovelluksellesi yksilöllisen client_id.

1. Uudelleenohjattu URL vastaanottaa varmennuskoodin koodi seuraavaa vaihetta varten.

Uudelleenohjattu URL näyttää tältä http://localhost:8080/?code=eb10956a-6d51-49e5-bbfe-9815e3fdc70a&state=54321.

1. Sovelluksesi on vaihdettava koodi kohteelle tokenit (access_token, refresh_token, id_token).

Esimerkki:

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
'

Vaihtoehto 3: API-avain

Nopea pääsy WMS- ja WFS-palveluihin on ajoittain tarpeen. Siksi on mahdollista käyttää GeoPard-tilille automaattisesti luotua API-avainta.

API-avain löytyy apiAvain UserData GraphQL-olion apiAvain attribuutista. Ohjeet hakemiseksi TÄSSÄ.

apiAvain on käytettävä yhdessä /geo päätepisteiden KANSSA VAIN.

Käyttö:

1. Kuten geopardApiKey parametri GET-pyynnön URL:issa.

2. Kuten X-API-Key otsikkona MISSÄ TAHANSA pyynnössä.