Autorizacija: ApiKey, prisijungimo duomenys arba OAuth 2.0

GeoPard sprendimas naudoja AWS Cognito autentifikacijos procedūrai.

Rekomenduojame patikrinti visas autorizacijos parinktis. Pasirinkimas priklauso nuo konkrečios naudojimo situacijos. Daugiau naudojimo detalių aprašyta kiekvienoje žemiau pateiktoje parinktyje.

1 variantas: Naudojant kredencialus

Autorizacija su „username“ ir „password“ yra viena iš galimų prieigų. Šiuo atveju turi būti atlikta registracija naudojant el. paštą (nenaudojant socialinių tinklų).

Šis metodas rekomenduojamas integracijai API (BackEnd) lygyje ir visi užklausimai į GeoPard API yra prox'inami per tam skirtą paslaugą (mikropaslaugą).

Prisijungimo užklausa

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

Prisijungimo atsakymas

Tokenas yra JWT su 30 minučių galiojimo laiku. Geriausia praktika — saugoti vieną tokeną ir pakartotinai jį naudoti visoms užklausoms, tikrinant jo galiojimo laiką ir gaunant naują tokeną, kai jis pasibaigia (arba netrukus prieš tai).

{
    "token": "<token_to_use_in_geopard_api>"
}

2 variantas: OAuth 2.0

AWS Cognito palaiko OAuth 2.0 protokolą autorizacijai. Bendras apžvalgos aprašymas pateiktas straipsnyje Cognito OAuth2 vadovas, poskirsnis Authorization Code Grant yra įdomiausias GeoPard atveju.

Šis metodas rekomenduojama integruoti GeoPard Vartotojo sąsajos (FrontEnd) lygyje. Integracija veikia abiem kryptimis — siųsti/gauti duomenis į/iš GeoPard.

Santraukai:

1. Jūsų programa turi peradresuoti vartotoją į GeoPard Cognito prisijungimui arba registracijai.

Pavyzdys:

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
'

Prašome susisiekti su GeoPard komanda, kad gautumėte savo programos individualų client_id.

1. Peradresuotas URL gaus patvirtinimo kodą kitam žingsniui.

Peradresuotas URL atrodys taip http://localhost:8080/?code=eb10956a-6d51-49e5-bbfe-9815e3fdc70a&state=54321.

1. Jūsų programa turi apsikeisti kodą skirti tokenais (access_token, refresh_token, id_token).

Pavyzdys:

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
'

3 variantas: API raktas

Greita prieiga prie WMS ir WFS kartais yra būtina. Todėl galima naudoti GeoPard API raktą, automatiškai sugeneruotą kiekvienam paskyrai.

API raktą galima rasti apiRaktas atribute „UserData" GraphQL entitete. Nurodymai, kaip gauti apiRaktas yra pateikti ČIA.

apiRaktas turi būti naudojamas kartu su /geo galūnėmis TIK.

Naudojimas:

1. Kaip geopardApiKey parametras GET užklausos URL.

2. Kaip X-API-Key antraštė bet kurioje užklausoje.