API Finance.HDdev
Integre o Finance.HDdev nas suas ferramentas. Aceda às suas contas, transações, orçamentos e categorias através de uma API REST simples e segura.
Autenticação
Bearer token (JWT). Obtenha o seu token a partir da sua área pessoal nas definições da conta.
URL base
Todos os pedidos utilizam o seguinte URL base:
https://finance.hddev.eu/api/v1Formato
Todos os pedidos e respostas utilizam o formato JSON. Header obrigatório: Content-Type: application/json
Exemplo de autenticação
curl -X GET https://finance.hddev.eu/api/v1/accounts \ -H "Authorization: Bearer VOTRE_TOKEN_JWT" \ -H "Content-Type: application/json"
Endpoints disponíveis
Panorama dos principais endpoints da API Finance.HDdev.
/api/v1/accountsLista de contas bancárias ligadas com saldos e metadados.
/api/v1/transactionsLista de transações com filtros (data, categoria, montante, conta).
/api/v1/budgetsOrçamentos e objetivos com progresso atual.
/api/v1/transactionsCriar uma transação manual (despesa, rendimento ou transferência).
/api/v1/categoriesCategorias disponíveis (de sistema e personalizadas).
Limites de frequência
Os pedidos à API estão sujeitos a limites de frequência para garantir a estabilidade do serviço.
Documentação completa
A documentação interativa completa (OpenAPI / Swagger) estará disponível em breve. Incluirá os esquemas de pedidos e respostas, os códigos de erro e exemplos detalhados.
Segurança
Todas as comunicações são encriptadas via HTTPS/TLS. Os tokens JWT expiram após 30 minutos (renovação automática via refresh token). A API é conforme com o RGPD e nunca retorna credenciais bancárias.
Precisa de ajuda com a API?
A nossa equipa técnica está disponível para o acompanhar na integração da API Finance.HDdev nas suas ferramentas e workflows.
Contactar a equipa APIapi@hddev.eu
Princípios de Arquitetura e Utilização
A API do Finance.HDdev baseia-se numa arquitetura RESTful, tornando-a previsível e fácil de utilizar. Todos os pedidos são efetuados via HTTPS para garantir a confidencialidade dos dados trocados. As respostas, assim como os corpos dos pedidos POST e PUT, são sistematicamente formatados em JSON. A estrutura dos URLs é orientada a recursos, permitindo-lhe interagir de forma intuitiva com os diferentes objetos do nosso sistema, como contas, transações ou orçamentos. Aplicamos um sistema de limitação de pedidos (rate limiting) para assegurar a estabilidade da plataforma para todos os utilizadores. Os detalhes destes limites são especificados no header de cada resposta.
Endpoints Principais e Casos de Uso
A nossa API expõe vários endpoints para cobrir o conjunto das funcionalidades de gestão financeira. O endpoint `/transactions` permite-lhe listar, filtrar e recuperar os detalhes de cada transação, ideal para análises aprofundadas de despesas. Com `/accounts`, pode obter a lista das suas contas ligadas e o seu saldo em tempo real. Para o acompanhamento orçamental, os endpoints `/budgets` e `/categories` dão-lhe controlo total sobre a criação e monitorização dos seus limites de despesa. Por fim, o endpoint `/goals` permite-lhe gerir os seus objetivos de poupança. Estas ferramentas combinadas abrem caminho a numerosas aplicações, do simples script de exportação de dados a uma aplicação mobile completa de coaching financeiro.
Autenticação e Segurança da API
A segurança é a nossa prioridade absoluta. O acesso à API é protegido por chaves de autenticação pessoais que pode gerar, gerir e revogar a partir do seu painel de utilizador. Cada pedido à API deve incluir a sua chave API no header `Authorization` sob a forma de Bearer Token. É imperativo manter estas chaves em segredo e nunca as expor do lado do cliente (em código JavaScript do navegador, por exemplo). Todas as ligações à API são encriptadas com TLS (SSL). Encorajamo-lo também a utilizar webhooks para receber notificações em tempo real sobre eventos importantes, como uma nova transação, em vez de interrogar continuamente a API, reduzindo assim o volume de pedidos e otimizando o desempenho.