Referenca e API-së (beta)

API e To Bill është ajo që përdor vetë aplikacioni: klientët, faturat, ofertat, artikujt, shpenzimet, banka, kontabiliteti, TVSH-ja, pagat dhe koha. Një çelës API personal ua hap atë skripteve dhe mjeteve tuaja, me të drejtat tuaja. Referenca interaktive e API-së përshkruan çdo rrugë që mund të thërrasë një çelës, parametrat dhe përgjigjet e saj, jep shembuj në curl, JavaScript, Python dhe PHP dhe ju lejon të provoni një kërkesë me çelësin tuaj.

Referenca është në anglisht

Si shumica e referencave teknike, ajo është shkruar në anglisht, gjuha e zhvilluesve. Kjo faqe përmbledh thelbin.

Një version beta

API është në version beta (0.x). Rrugët e saj dhe përgjigjet e tyre mund të ndryshojnë pa njoftim paraprak: nuk ka as garanci përputhshmërie, as mbështetje për përdorimin e saj të drejtpërdrejtë. Për të lidhur një asistent IA, përdorni serverin MCP, që është ndërfaqja e qëndrueshme: shihni Lidhni një asistent IA.

Vërtetimi

Çdo kërkesë mban një çelës API personal në kokën HTTP Authorization:

curl https://app.tobill.ch/api/clients -H "Authorization: Bearer tb_pk_…"

Çelësi krijohet te Cilësimet › Lidhjet IA dhe API: shihni API dhe çelësat API. Ai vepron në emrin tuaj, në ndërmarrjen ku e krijuat, me të drejtat tuaja në atë ndërmarrje. Një çelës Vetëm lexim dërgon vetëm kërkesa leximi (GET); një çelës Lexim dhe ndryshim mund edhe të krijojë, të ndryshojë dhe të fshijë.

Gabimet

Një kërkesë e refuzuar merr një përgjigje JSON të kësaj forme: { "statusMessage": "error", "message": "…", "error_code": "…", "fallback": "…" }. message është një kod i qëndrueshëm për ta kontrolluar programi juaj; fallback është një fjali e lexueshme, për shembull me fushën në fjalë.

Kodi HTTP	Kuptimi
400	Të dhëna të pavlefshme.
401	Çelësi mungon, është i pavlefshëm, i skaduar ose i revokuar.
403	Refuzuar: çelës vetëm për lexim, mungon një e drejtë, abonim pa qasje në API, ose pjesë e To Bill e mbyllur për çelësat (not_available_with_api_token).
404	Nuk u gjet në këtë ndërmarrje.
429	Shumë kërkesa: prisni aq sekonda sa tregon koka Retry-After.

Kufijtë

• 300 kërkesa në minutë për çelës; një ndryshim numërohet dyfish.
• Një çelës nuk hap as identifikimin në llogarinë tuaj, as abonimin, as pagesat, as menaxhimin e ekipit dhe të çelësave, as një ndërmarrje tjetër, as cockpit-in e një fiduciari, as veprimet masive. Këto rrugë nuk janë në referencë.

Specifikimi OpenAPI

Referenca gjenerohet nga dokumenti OpenAPI 3.1 i API-së. Mund ta importoni në një mjet si Postman ose të gjeneroni një klient prej tij:

Çfarë	Adresa
Referenca interaktive	https://docs.tobill.ch/api
Specifikimi OpenAPI 3.1	https://app.tobill.ch/api/openapi.json

Provoni një kërkesë

Në referencë, butoni Test Request e dërgon kërkesën nga shfletuesi juaj drejtpërdrejt te https://app.tobill.ch, pa ndërmjetës. Çelësi juaj shkon vetëm te To Bill dhe nuk ruhet: zhduket kur e mbyllni faqen. Një kërkesë ndryshimi i ndryshon vërtet të dhënat tuaja: për ta njohur API-në, provojeni me një çelës Vetëm lexim.