Autenticação

Conectando-se às Nossas APIs Utilizando JWT

Para garantir a segurança no acesso às nossas APIs, utilizamos JSON Web Tokens (JWT) e restrição de IP. A seguir, detalhamos o processo para conectar-se de maneira segura.

Passo 1: Obtenção do JWT

1. Solicitação do JWT: Entre em contato com a equipe de segurança para solicitar seu JWT. Este token é um identificador único que permite autenticar suas solicitações à nossa API.

2. Validade do Token: Verifique a validade do seu JWT e renove-o conforme necessário, já que ele pode expirar. A equipe de segurança pode informar o tempo de validade.

Passo 2: Registro do IP Fixo

1. IP Fixo: Você deve fornecer um endereço IP fixo. Apenas este IP terá permissão para acessar a API.

2. eAtualizações de IP: Caso haja uma alteração no seu IP, notifique imediatamente a equipe de segurança para atualizar nosso whitelist e garantir acesso contínuo.

Passo 3: Configuração de Cabeçalho de Autorização

1. Cabeçalho HTTP: Todas as requisições à API devem incluir o cabeçalho Authorization com o Bearer Token. O formato deve ser:

   Authorization: Bearer <seu_JWT>

2. Solicitação do Token Para obter um JWT válido, envie a seguinte requisição para o endpoint de autenticação

POST /auth/token
Host: gateway.vert-capital.app
Content-Type: application/json

{
  "api_key": "",
  "secret_api_key": ""
}

A resposta conterá tanto o JWT quanto o refresh token

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR...",
  "refresh_token": "dGhpcyBpcyBhIHJlZnJlc2ggdG9rZW4...",
  "expires_in": 86400
}

Para renovar um JWT expirado, utilize o refresh token na seguinte requisição

POST /auth/refresh
Host: gateway.vert-capital.app
Content-Type: application/json

{
  "refresh_token": "dGhpcyBpcyBhIHJlZnJlc2ggdG9rZW4..."
}

A resposta conterá tanto o JWT quanto o refresh token

{
  "access_token": "novo_JWT_gerado",
  "refresh_token": "novo_refresh_token",
  "expires_in": 86400
}

Segurança

Para manter a integridade e segurança do acesso à API, siga as diretrizes abaixo:

• Renovação do Token: O JWT tem validade de 24 horas e deve ser renovado automaticamente para evitar interrupções no acesso. Recomenda-se a implementação de um mecanismo de renovação do token antes do vencimento.

  • Utilize a API de renovação de token disponibilizada para obter um novo JWT antes que o atual expire.

  • Caso o token expire, todas as requisições serão rejeitadas até que um novo token seja obtido.

• Armazenamento Seguro: Nunca armazene o JWT em locais de fácil acesso, como arquivos de configuração em repositórios públicos. Utilize cofres de segredos ou variáveis de ambiente seguras.

• Requisições Seguras: Todas as requisições à API devem ser feitas utilizando HTTPS para evitar interceptação de dados.

• Monitoramento e Revogação: Caso suspeite de uso indevido do seu token, informe imediatamente a equipe de segurança para que ele seja revogado e um novo seja gerado.