API Finance.HDdev
Comhtháthigh Finance.HDdev le d'uirlisí. Rochtain ar do chuntais, idirbhearta, buiséid agus catagóirí trí REST API simplí agus slán.
Fíordheimhniú
Comhartha Bearer (JWT). Faigh do chomhartha ó do phainéal pearsanta i socruithe an chuntais.
Bun-URL
Úsáideann gach iarratas an bun-URL seo a leanas:
https://finance.hddev.eu/api/v1Formáid
Úsáideann gach iarratas agus freagra formáid JSON. Ceanntásc riachtanach: Content-Type: application/json
Sampla fíordheimhnithe
curl -X GET https://finance.hddev.eu/api/v1/accounts \ -H "Authorization: Bearer VOTRE_TOKEN_JWT" \ -H "Content-Type: application/json"
Críochphointí ar fáil
Forbhreathnú ar phríomhchríochphointí API Finance.HDdev.
/api/v1/accountsLiosta cuntais bhainc ceangailte le hiarmhéideanna agus meiteashonraí.
/api/v1/transactionsLiosta idirbheart le scagairí (dáta, catagóir, méid, cuntas).
/api/v1/budgetsBuiséid agus spriocanna leis an dul chun cinn reatha.
/api/v1/transactionsCruthaigh idirbheart láimhe (caiteachas, ioncam nó aistriú).
/api/v1/categoriesCatagóirí ar fáil (córais agus saincheaptha).
Teorainneacha ráta
Tá iarrataí API teoranta chun cobhsaíocht na seirbhíse a chinntiú.
Doiciméadú iomlán
Beidh an doiciméadú iomlán idirghníomhach (OpenAPI / Swagger) ar fáil go luath. Áireofar ann scéimeanna iarratas agus freagartha, cóid earráide agus samplaí mionsonraithe.
Slándáil
Criptítear gach cumarsáid trí HTTPS/TLS. Éagann comharthaí JWT tar éis 30 nóiméad (athnuachan uathoibríoch trí chomhartha athnuachana). Tá an API i gcomhréir le GDPR agus ní fhilleann sé dintiúir bhainc riamh.
An bhfuil cabhair ag teastáil uait leis an API?
Tá ár bhfoireann theicniúil ar fáil chun cabhrú leat API Finance.HDdev a chomhtháthú le d'uirlisí agus do shreafaí oibre.
Déan teagmháil le foireann an APIapi@hddev.eu
Prionsabail Ailtireachta agus Úsáid
Tá API Finance.HDdev bunaithe ar ailtireacht RESTful, rud a fhágann go bhfuil sé intuartha agus éasca le húsáid. Déantar gach iarratas trí HTTPS chun rúndacht na sonraí malartaithe a chinntiú. Formáidítear freagraí, mar aon le comhlachtaí iarratas POST agus PUT, go córasach i JSON. Tá struchtúr an URL dírithe ar acmhainní, rud a ligeann duit idirghníomhú go hiomasach leis na hábhair éagsúla inár gcóras, ar nós cuntais, idirbhearta nó buiséid. Cuirimid córas teorannaithe ráta i bhfeidhm chun cobhsaíocht an ardáin a chinntiú d'úsáideoirí go léir. Sonraítear mionsonraí na dteorainneacha seo i gceanntásc gach freagartha.
Príomhchríochphointí agus Cásanna Úsáide
Nochtar roinnt críochphointí ag ár API chun gach gné de bhainistíocht airgeadais a chlúdach. Ligeann an críochphointe `/transactions` duit liosta a dhéanamh de, scagadh agus sonraí gach idirbhirt a fháil, oiriúnach d'anailísí domhain caiteachais. Le `/accounts`, is féidir leat liosta do chuntais cheangailte agus a n-iarmhéideanna i bhfíor-am a fháil. Maidir le rianú buiséid, tugann na críochphointí `/budgets` agus `/categories` smacht iomlán duit ar do chlúdaigh chaiteachais a chruthú agus a mhonatóireacht. Ar deireadh, ligeann an críochphointe `/goals` duit do spriocanna coigiltis a bhainistiú. Osclaíonn na huirlisí comhcheangailte seo an doras do go leor feidhmchlár, ó script onnmhairithe sonraí simplí go dtí aip mhóibíleach iomlán cóitseála airgeadais.
Fíordheimhniú agus Slándáil API
Is í an tslándáil ár dtosaíocht iomlán. Cosnaítear rochtain API le heochracha fíordheimhnithe pearsanta ar féidir leat iad a ghiniúint, a bhainistiú agus a chúlghairm ó do phainéal úsáideora. Ní mór do gach iarratas API d'eochair API a chur san áireamh sa cheanntásc `Authorization` mar Chomhartha Bearer. Tá sé fíorthábhachtach na heochracha seo a choinneáil rúnda agus gan iad a nochtadh ar thaobh an chliaint. Criptítear gach ceangal API le TLS (SSL). Molaimid duit freisin webhooks a úsáid chun fógraí fíor-ama a fháil ar imeachtaí tábhachtacha, ar nós idirbheart nua, seachas an API a vótáil go leanúnach, rud a laghdaíonn líon na n-iarratas agus a optamaíonn feidhmíocht.