Autorização: ApiKey, Credenciais ou OAuth 2.0

A solução GeoPard está usando AWS Cognito para o procedimento de autenticação.

Recomendamos verificar todas as opções de autorização. A escolha depende do caso de uso específico. Mais detalhes de uso são descritos em cada opção abaixo.

Opção 1: Usando Credenciais

Autenticação com “nome de usuário” e “senha” é uma das abordagens possíveis. Neste caso, o registro por e-mail deve ser realizado (não usando redes sociais).

A abordagem é recomendada para integração no nível da API (BackEnd) e todas as requisições para a API GeoPard são encaminhadas via um serviço especial dedicado (microserviço).

Requisição de Login

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

Resposta de Login

O token é um JWT com validade de 30 minutos. É uma boa prática armazenar um único token e reutilizá-lo em todas as requisições, verificando seu tempo de expiração e obtendo um novo token quando ele expirar (ou pouco antes).

{
    "token": "<token_to_use_in_geopard_api>"
}

Opção 2: OAuth 2.0

O AWS Cognito suporta o protocolo OAuth 2.0 para autorização. A visão geral é descrita no artigo Manual Cognito OAuth2, o sub-artigo Authorization Code Grant é o mais interessante no caso GeoPard.

A abordagem é recomendado integrar o GeoPard no nível da Interface do Usuário (FrontEnd). A integração funciona em ambas as direções para enviar/receber dados para/de o GeoPard.

Resumindo:

1. Sua aplicação precisa redirecionar o usuário para o Cognito do GeoPard para login ou registro.

Exemplo:

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
'

Por favor, conecte-se com a equipe do GeoPard para receber o seu client_id.

1. A URL redirecionada receberá um código para o próximo passo.

A URL redirecionada fica como http://localhost:8080/?code=eb10956a-6d51-49e5-bbfe-9815e3fdc70a&state=54321.

1. Sua aplicação precisa trocar código para tokens (access_token, refresh_token, id_token).

Exemplo:

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
'

Opção 3: Chave de API

Acesso rápido a WMS e WFS é necessário de vez em quando. Portanto, é possível usar a chave de API do GeoPard gerada automaticamente para cada conta.

A chave de API pode ser encontrada no apiKey atributo da entidade GraphQL "UserData". Instruções sobre como recuperar apiKey são fornecidas AQUI.

apiKey deve ser usada com /geo endpoints SOMENTE.

Uso:

1. Como um geopardApiKey parâmetro na URL da requisição GET.

2. Como um cabeçalho X-API-Key em QUALQUER requisição.