Avtorizacija: ApiKey, poverilnice ali OAuth 2.0

Rešitev GeoPard uporablja AWS Cognito za postopek avtentikacije.

Priporočamo, da preverite vse možnosti avtorizacije. Izbira je odvisna od konkretnega primera uporabe. Več podrobnosti o uporabi je opisano pri vsaki spodnji možnosti.

Možnost 1: Uporaba poverilnic

Avtorizacija z »uporabniškim imenom« in »geslom« je ena izmed možnih pristopov. V tem primeru se mora registracija po e-pošti opraviti (ne z uporabo družbenih omrežij).

Pristop je priporočljiv za integracijo na ravni API (BackEnd) in so vsi zahtevki do GeoPard API posredovani prek namenske posebne storitve (mikrostoritve).

Zahteva za prijavo

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

Odgovor na prijavo

Token je JWT z življenjsko dobo 30 minut. Najboljša praksa je shraniti en sam token in ga ponovno uporabiti v vseh zahtevkih, preverjati njegov čas poteka in pridobiti nov token, ko poteče (ali kmalu pred tem).

{
    "token": "<token_to_use_in_geopard_api>"
}

Možnost 2: OAuth 2.0

AWS Cognito podpira protokol OAuth 2.0 za avtorizacijo. Splošen pregled je opisan v članku Cognito OAuth2 priročnik, podčlanek Authorization Code Grant pa je v primeru GeoPard najbolj zanimiv.

Pristop je priporočljivo integrirati GeoPard na raven uporabniškega vmesnika (FrontEnd). Integracija deluje v obe smeri za pošiljanje/prejemanje podatkov v/iz GeoPard.

Na kratko:

1. Vaša aplikacija mora preusmeriti uporabnika na GeoPard Cognito za prijavo ali registracijo.

Primer:

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
'

Prosimo, povežite se z ekipo GeoPard, da prejmete svoj aplikaciji lasten client_id.

1. Preusmerjeni URL bo prejel verifikacijsko kodo za naslednji korak.

Preusmerjeni URL izgleda takole http://localhost:8080/?code=eb10956a-6d51-49e5-bbfe-9815e3fdc70a&state=54321.

1. Vaša aplikacija mora zamenjati kodo za tokene (access_token, refresh_token, id_token).

Primer:

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
'

Možnost 3: API ključ

Hiter dostop do WMS in WFS je občasno potreben. Zato je mogoče uporabiti GeoPard API ključ, ki se samodejno ustvari za vsak račun.

API ključ lahko najdete v apiKljuč atributu entitete GraphQL »UserData«. Navodila, kako pridobiti apiKljuč so zagotovljena TUKAJ.

apiKljuč mora se uporabljati z /geo končnimi točkami SAMO.

Uporaba:

1. Kot geopardApiKey parameter v URL-ju GET zahteve.

2. Kot X-API-Key glava v KATERIKOLI zahtevi.