Autenticação

A autenticação na API Fintely é feita via API Key enviada no cabeçalho HTTP de cada requisição.

Como Autenticar

Inclua sua chave de API no header x-api-key em todas as requisições:

Code
 
curl -X GET https://api.fintely.com.br/v1/persons \
  -H "x-api-key: sua_api_key_aqui" \
  -H "Content-Type: application/json"

Obtendo sua API Key

A API Key pode ser gerada diretamente no painel do Fintely, na seção de Configurações > API.

Boas Práticas

• Nunca exponha sua API Key no código-fonte do frontend, repositórios públicos ou aplicações acessíveis pelo usuário final.
• Para aplicações web e mobile, realize as chamadas à API pelo servidor (backend). O frontend deve se comunicar apenas com seu próprio servidor.
• Rotacione suas chaves periodicamente e revogue chaves comprometidas imediatamente.
• Use variáveis de ambiente para armazenar suas credenciais de forma segura.

Exemplo de Requisição

Code
 
const response = await fetch('https://api.fintely.com.br/v1/persons', {
  method: 'GET',
  headers: {
    'x-api-key': process.env.FINTELY_API_KEY,
    'Content-Type': 'application/json',
  },
});

const data = await response.json();