API Finance.HDdev
Integruokite Finance.HDdev į savo įrankius. Prieiga prie sąskaitų, operacijų, biudžetų ir kategorijų per paprastą ir saugų REST API.
Autentifikavimas
Bearer žetonas (JWT). Gaukite savo žetoną iš asmeninio valdymo skydelio paskyros nustatymuose.
Bazinis URL
Visi užklausimai naudoja šį bazinį URL:
https://finance.hddev.eu/api/v1Formatas
Visi užklausimai ir atsakymai naudoja JSON formatą. Privaloma antraštė: Content-Type: application/json
Autentifikavimo pavyzdys
curl -X GET https://finance.hddev.eu/api/v1/accounts \ -H "Authorization: Bearer VOTRE_TOKEN_JWT" \ -H "Content-Type: application/json"
Prieinami galutiniai taškai
Pagrindinių Finance.HDdev API galutinių taškų apžvalga.
/api/v1/accountsPrijungtų banko sąskaitų sąrašas su likučiais ir metaduomenimis.
/api/v1/transactionsOperacijų sąrašas su filtrais (data, kategorija, suma, sąskaita).
/api/v1/budgetsBiudžetai ir tikslai su esama pažanga.
/api/v1/transactionsSukurti rankinę operaciją (išlaidos, pajamos arba pervedimas).
/api/v1/categoriesPrieinamos kategorijos (sisteminės ir individualios).
Užklausų limitai
API užklausimai yra ribojami, siekiant užtikrinti paslaugos stabilumą.
Pilna dokumentacija
Pilna interaktyvi dokumentacija (OpenAPI / Swagger) bus prieinama netrukus. Joje bus užklausų ir atsakymų schemos, klaidų kodai ir išsamūs pavyzdžiai.
Saugumas
Visa komunikacija šifruojama per HTTPS/TLS. JWT žetonai baigia galioti po 30 minučių (automatinis atnaujinimas per refresh žetoną). API atitinka BDAR ir niekada negrąžina banko prisijungimo duomenų.
Reikia pagalbos su API?
Mūsų techninė komanda pasiruošusi padėti integruoti Finance.HDdev API į jūsų įrankius ir darbo procesus.
Susisiekti su API komandaapi@hddev.eu
Architektūros principai ir naudojimas
Finance.HDdev API remiasi RESTful architektūra, todėl yra nuspėjamas ir lengvai naudojamas. Visi užklausimai atliekami per HTTPS, siekiant užtikrinti keičiamų duomenų konfidencialumą. Atsakymai ir POST bei PUT užklausų turinys sistemingai formatuojami JSON formatu. URL struktūra orientuota į išteklius, leidžianti intuityviai sąveikauti su skirtingais mūsų sistemos objektais, tokiais kaip sąskaitos, operacijos ar biudžetai. Taikome užklausų ribojimo sistemą, siekiant užtikrinti platformos stabilumą visiems vartotojams. Šių limitų detalės nurodomos kiekvieno atsakymo antraštėje.
Pagrindiniai galutiniai taškai ir naudojimo atvejai
Mūsų API pateikia kelis galutinius taškus, apimančius visas finansų valdymo funkcijas. Galutinis taškas `/transactions` leidžia sąrašuoti, filtruoti ir gauti kiekvienos operacijos detales, idealiai tinkantis išsamioms išlaidų analizėms. Su `/accounts` galite gauti prijungtų sąskaitų sąrašą ir jų likučius realiuoju laiku. Biudžeto sekimui galutiniai taškai `/budgets` ir `/categories` suteikia pilną kontrolę kuriant ir stebint savo išlaidų vokus. Galutinis taškas `/goals` leidžia valdyti taupymo tikslus. Šie kombinuoti įrankiai atveria duris daugeliui programų, nuo paprasto duomenų eksporto skripto iki išsamios mobiliosios finansinio koučingo programėlės.
API autentifikavimas ir saugumas
Saugumas yra mūsų absoliutus prioritetas. API prieiga apsaugota asmeniniais autentifikavimo raktais, kuriuos galite generuoti, valdyti ir atšaukti iš savo vartotojo valdymo skydelio. Kiekvienas API užklausimas turi turėti jūsų API raktą `Authorization` antraštėje kaip Bearer žetoną. Būtina šiuos raktus laikyti slaptai ir niekada neatskleisti kliento pusėje. Visi API ryšiai šifruojami TLS (SSL). Taip pat rekomenduojame naudoti webhook'us realaus laiko pranešimams apie svarbius įvykius, pvz., naują operaciją, vietoj nuolatinio API apklausimo, taip sumažinant užklausų kiekį ir optimizuojant veikimą.