API Finance.HDdev
Integrujte Finance.HDdev do svých nástrojů. Přistupujte ke svým účtům, transakcím, rozpočtům a kategoriím přes jednoduché a bezpečné REST API.
Autentizace
Bearer token (JWT). Získejte svůj token z osobního přehledu v nastavení účtu.
Základní URL
Všechny požadavky používají následující základní URL:
https://finance.hddev.eu/api/v1Formát
Všechny požadavky a odpovědi používají formát JSON. Povinná hlavička: Content-Type: application/json
Příklad autentizace
curl -X GET https://finance.hddev.eu/api/v1/accounts \ -H "Authorization: Bearer VOTRE_TOKEN_JWT" \ -H "Content-Type: application/json"
Dostupné endpointy
Přehled hlavních endpointů API Finance.HDdev.
/api/v1/accountsSeznam připojených bankovních účtů se zůstatky a metadaty.
/api/v1/transactionsSeznam transakcí s filtry (datum, kategorie, částka, účet).
/api/v1/budgetsRozpočty a cíle s aktuálním pokrokem.
/api/v1/transactionsVytvořte ruční transakci (výdaj, příjem nebo převod).
/api/v1/categoriesDostupné kategorie (systémové a vlastní).
Limity požadavků
Požadavky na API jsou omezeny pro zajištění stability služby.
Kompletní dokumentace
Kompletní interaktivní dokumentace (OpenAPI / Swagger) bude brzy k dispozici. Bude obsahovat schémata požadavků a odpovědí, chybové kódy a podrobné příklady.
Zabezpečení
Veškerá komunikace je šifrována přes HTTPS/TLS. JWT tokeny vyprší po 30 minutách (automatické obnovení přes refresh token). API je v souladu s GDPR a nikdy nevrací bankovní přihlašovací údaje.
Potřebujete pomoc s API?
Náš technický tým je k dispozici, aby vám pomohl s integrací API Finance.HDdev do vašich nástrojů a pracovních postupů.
Kontaktovat tým APIapi@hddev.eu
Architektonické principy a použití
API Finance.HDdev je založeno na architektuře RESTful, díky čemuž je předvídatelné a snadno použitelné. Všechny požadavky se provádějí přes HTTPS pro zajištění důvěrnosti vyměňovaných dat. Odpovědi i těla požadavků POST a PUT jsou systematicky formátovány v JSON. Struktura URL je orientována na zdroje, což vám umožňuje intuitivně pracovat s různými objekty našeho systému, jako jsou účty, transakce nebo rozpočty. Aplikujeme systém omezení požadavků pro zajištění stability platformy pro všechny naše uživatele. Podrobnosti o těchto limitech jsou uvedeny v každé hlavičce odpovědi.
Klíčové endpointy a případy použití
Naše API vystavuje několik endpointů pokrývajících všechny funkce správy financí. Endpoint `/transactions` umožňuje vypsat, filtrovat a získat podrobnosti o každé transakci, ideální pro hloubkovou analýzu výdajů. S `/accounts` můžete získat seznam připojených účtů a jejich zůstatky v reálném čase. Pro sledování rozpočtu vám endpointy `/budgets` a `/categories` dávají plnou kontrolu nad vytvářením a sledováním vašich výdajových obálek. Endpoint `/goals` umožňuje spravovat vaše spořicí cíle. Tyto kombinované nástroje otevírají dveře mnoha aplikacím, od jednoduchého skriptu pro export dat po kompletní mobilní aplikaci pro finanční koučink.
Autentizace a zabezpečení API
Zabezpečení je naší absolutní prioritou. Přístup k API je chráněn osobními autentizačními klíči, které můžete generovat, spravovat a odvolat z vašeho uživatelského přehledu. Každý požadavek na API musí obsahovat váš API klíč v hlavičce `Authorization` jako Bearer Token. Je nezbytné udržovat tyto klíče v tajnosti a nikdy je nevystavovat na straně klienta (v kódu JavaScript prohlížeče). Všechna připojení API jsou šifrována pomocí TLS (SSL). Doporučujeme také používat webhooky pro příjem notifikací v reálném čase o důležitých událostech, jako je nová transakce, místo neustálého dotazování API, čímž se snižuje objem požadavků a optimalizuje výkon.