API Finance.HDdev
Integrirajte Finance.HDdev v svoja orodja. Dostopite do svojih racunov, transakcij, proracunov in kategorij prek enostavnega in varnega REST API.
Avtentikacija
Bearer zeton (JWT). Pridobite svoj zeton iz osebne nadzorne plosce v nastavitvah racuna.
Osnovni URL
Vse zahteve uporabljajo naslednji osnovni URL:
https://finance.hddev.eu/api/v1Format
Vse zahteve in odgovori uporabljajo format JSON. Obvezna glava: Content-Type: application/json
Primer avtentikacije
curl -X GET https://finance.hddev.eu/api/v1/accounts \ -H "Authorization: Bearer VOTRE_TOKEN_JWT" \ -H "Content-Type: application/json"
Razpolozljive koncne tocke
Pregled glavnih koncnih tock API Finance.HDdev.
/api/v1/accountsSeznam povezanih bancnih racunov s stanji in metapodatki.
/api/v1/transactionsSeznam transakcij s filtri (datum, kategorija, znesek, racun).
/api/v1/budgetsProracuni in cilji s trenutnim napredkom.
/api/v1/transactionsUstvarite rocno transakcijo (izdatek, prihodek ali prenos).
/api/v1/categoriesRazpolozljive kategorije (sistemske in po meri).
Omejitve zahtev
Zahteve API so omejene za zagotovitev stabilnosti storitve.
Celotna dokumentacija
Celotna interaktivna dokumentacija (OpenAPI / Swagger) bo kmalu na voljo. Vkljucevala bo sheme zahtev in odgovorov, kode napak in podrobne primere.
Varnost
Vsa komunikacija je sifrirana prek HTTPS/TLS. Zetoni JWT potecejo po 30 minutah (samodejna obnova prek zetona za osvezitev). API je skladen z GDPR in nikoli ne vraca bancnih prijavnih podatkov.
Potrebujete pomoc z API?
Nasa tehnicna ekipa je na voljo, da vam pomaga pri integraciji Finance.HDdev API v vasa orodja in delovne procese.
Kontaktirajte ekipo za APIapi@hddev.eu
Arhitekturni principi in uporaba
Finance.HDdev API temelji na arhitekturi RESTful, kar ga naredi predvidljivega in enostavnega za uporabo. Vse zahteve se izvajajo prek HTTPS za zagotovitev zaupnosti izmenjanih podatkov. Odgovori, pa tudi telesa zahtev POST in PUT, so sistematicno oblikovani v JSON. Struktura URL je usmerjena na vire, kar vam omogoca intuitivno interakcijo z razlicnimi objekti v nasem sistemu, kot so racuni, transakcije ali proracuni. Uporabljamo sistem omejevanja hitrosti za zagotovitev stabilnosti platforme za vse nase uporabnike. Podrobnosti o teh omejitvah so navedene v glavi vsakega odgovora.
Kljucne koncne tocke in primeri uporabe
Nas API izpostavlja vec koncnih tock za pokritje vseh funkcionalnosti financnega upravljanja. Koncna tocka `/transactions` vam omogoca seznam, filtriranje in pridobivanje podrobnosti vsake transakcije, idealna za poglobljeno analizo izdatkov. S `/accounts` lahko pridobite seznam svojih povezanih racunov in njihova stanja v realnem casu. Za spremljanje proracuna vam koncni tocki `/budgets` in `/categories` dajeta poln nadzor nad ustvarjanjem in spremljanjem vasih ovojnic za izdatke. Nazadnje, koncna tocka `/goals` vam omogoca upravljanje vasih varcevalnih ciljev. Ta kombinirana orodja odpirajo vrata stevilnim aplikacijam, od enostavnega skripta za izvoz podatkov do celotne mobilne aplikacije za financni coaching.
Avtentikacija in varnost API
Varnost je nasa absolutna prednostna naloga. Dostop do API je zasciten z osebnimi avtentikacijskimi kljuci, ki jih lahko generirate, upravljate in prekličete z vase nadzorne plosce. Vsaka zahteva API mora vkljucevati vas kljuc API v glavi `Authorization` kot Bearer Token. Nujno je, da te kljuce ohranite tajne in jih nikoli ne izpostavljate na strani odjemalca (na primer v brskalniku JavaScript). Vse povezave API so sifrirane s TLS (SSL). Spodbujamo vas tudi k uporabi webhookov za prejemanje obvestil v realnem casu o pomembnih dogodkih, kot je nova transakcija, namesto stalnega posiljanja poizvedb API-ju, s cimer se zmanjsa obseg zahtev in optimizira zmogljivost.