Conceitos básicos
Estrutura dos endpoints
Todos os endpoints da API REST são acessados através da URL base:
https://api.finlight.me
Os endpoints são estruturados usando métodos HTTP padrão e esperam que os parâmetros sejam enviados como query strings.
Versionamento da API
A API REST é versionada para garantir compatibilidade com versões anteriores. A versão atual é v2. Todos os endpoints incluem o número da versão na URL:
https://api.finlight.me/v2/...
Isso permite atualizações futuras sem quebrar integrações existentes.
Cabeçalhos de autenticação
Autentique suas requisições à API REST incluindo sua chave de API no cabeçalho X-API-KEY:
X-API-KEY: YOUR_API_KEY
Se você usa nossas bibliotecas cliente, esse cabeçalho é tratado automaticamente para você. Você pode obter sua chave de API no painel do finlight.