Удостоверяване: ApiKey, идентификационни данни или OAuth 2.0

Решението GeoPard използва AWS Cognito за процедурата по удостоверяване.

Препоръчваме да проверите всички опции за авторизация. Изборът зависи от конкретния случай на употреба. Повече подробности за използването са описани във всяка опция по-долу.

Опция 1: Използване на идентификационни данни

Удостоверяване с „потребителско име“ и „парола“ е един от възможните подходи. В този случай регистрацията по имейл трябва да бъде извършена (без използване на социални мрежи).

Подходът е препоръчителен за интеграция на ниво API (BackEnd) и всички заявки към GeoPard API се проксират чрез специална отделна услуга (микросървис).

Заявка за вход

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

Отговор при вход

Токенът е JWT със срок на валидност 30 минути. Най-добра практика е да се съхранява един токен и да се използва повторно за всички заявки, като се проверява времето на изтичане и се извлича нов токен, когато изтече (или малко преди това).

{
    "token": "<token_to_use_in_geopard_api>"
}

Опция 2: OAuth 2.0

AWS Cognito поддържа протокол OAuth 2.0 за авторизация. Общият преглед е описан в статията Cognito OAuth2 ръководство, подтемата Authorization Code Grant е най-интересна за случая с GeoPard.

Подходът е препоръчително да се интегрира GeoPard на ниво Потребителски интерфейс (FrontEnd). Интеграцията работи и в двете посоки за изпращане/получаване на данни до/от GeoPard.

Накратко:

1. Вашето приложение трябва да пренасочи потребителя към GeoPard Cognito за вход или регистрация.

Пример:

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
'

Моля, свържете се с екипа на GeoPard, за да получите индивидуалния за вашето приложение client_id.

1. Пренасоченият URL ще получи проверъчен код за следващата стъпка.

Пренасоченият URL изглежда като http://localhost:8080/?code=eb10956a-6d51-49e5-bbfe-9815e3fdc70a&state=54321.

1. Вашето приложение трябва да разменя код за токени (access_token, refresh_token, id_token).

Пример:

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: API ключ

Бърз достъп до WMS и WFS понякога е необходим. Поради това е възможно да се използва GeoPard API ключ, автоматично генериран за всеки акаунт.

API ключът може да бъде намерен в apiКлюч атрибута на GraphQL ентитета "UserData". Инструкции как да извлечете apiКлюч са предоставени ТУК.

apiКлюч трябва да се използва с /geo крайни точки САМО.

Използване:

1. Като geopardApiKey параметър в URL на GET заявката.

2. Като X-API-Key заглавка в ВСЯКА заявка.