Autorisation : ApiKey, Credentials ou OAuth 2.0

La solution GeoPard utilise AWS Cognito pour la procédure d'authentification.

Nous recommandons de vérifier toutes les options d'autorisation. Le choix dépend du cas d'utilisation particulier. Plus de détails d'utilisation sont décrits dans chaque option ci‑dessous.

Option 1 : Utilisation des identifiants

L'autorisation avec « nom d'utilisateur » et « mot de passe » est l'une des approches possibles. Dans ce cas, l'enregistrement par e‑mail doit être effectué (sans utiliser les réseaux sociaux).

L'approche est recommandée pour l'intégration au niveau de l'API (BackEnd) et toutes les requêtes vers l'API GeoPard sont transmises via un service dédié spécial (microservice).

Requête de connexion

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

Réponse de connexion

Le token est un JWT d'une durée de vie de 30 minutes. Il est recommandé de stocker un seul token et de le réutiliser pour toutes les requêtes, en vérifiant son heure d'expiration et en récupérant un nouveau token lorsqu'il expire (ou peu avant).

{
    "token" : "<token_to_use_in_geopard_api>"
}

Option 2 : OAuth 2.0

AWS Cognito prend en charge le protocole OAuth 2.0 pour l'autorisation. Un aperçu général est décrit dans l'article Manuel Cognito OAuth2, le sous-article Authorization Code Grant est le plus intéressant dans le cas de GeoPard.

L'approche est recommandé d'intégrer GeoPard au niveau de l'interface utilisateur (FrontEnd). L'intégration fonctionne dans les deux sens pour envoyer/recevoir des données vers/depuis GeoPard.

Pour faire court :

1. Votre application doit rediriger un utilisateur vers Cognito GeoPard pour la connexion ou l'inscription.

Exemple :

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
'

Veuillez vous connecter avec l'équipe GeoPard pour recevoir l' client_id.

1. L'URL redirigée recevra un code de vérification pour l'étape suivante.

L'URL redirigée ressemble à http://localhost:8080/?code=eb10956a-6d51-49e5-bbfe-9815e3fdc70a&state=54321.

1. Votre application doit échanger code pour des tokens (access_token, refresh_token, id_token).

Exemple :

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
'

Option 3 : Clé API

Un accès rapide à WMS et WFS est parfois nécessaire. Par conséquent, il est possible d'utiliser la clé API GeoPard générée automatiquement pour chaque compte.

La clé API peut être trouvée dans cléApi l'attribut de l'entité GraphQL "UserData". Des instructions sur la façon de récupérer cléApi sont fournies ICI.

cléApi doit être utilisé avec /geo points de terminaison UNIQUEMENT.

Utilisation :

1. En tant que geopardApiKey paramètre dans l'URL de la requête GET.

2. En tant que X-API-Key en‑tête dans TOUTE requête.