REST API kasutamine

MoneyLights REST API võimaldab sinu süsteemidel lugeda ja hallata sinu organisatsiooni andmeid: tehingud, teenusepakkujad, kliendid, projektid, kategooriad ja rahavoog. Sa autentid end API võtmega.

API kutsumine

Saada oma võti X-API-Key päises:

GET /api/transactions HTTP/1.1
Host: api.moneylights.app
X-API-Key: ml_sk_<key-id>_<secret>

Authorization: ApiKey <key> töötab samuti. Authorization: Bearer <key> ei tööta — Bearer kuulub brauseri sessioonile. Ära pane võtit URL-i: sellised päringud keelatakse enne, kui nad kuhugi jõuavad.

Masinloetav viide

Täielik, alati ajakohane nimekiri sellest, mida sinu võti ulatub, on avalik OpenAPI dokument:

GET https://api.moneylights.app/api/public/openapi.json

See genereeritakse töötava rakenduse põhjal ja loetleb täpselt avaldatud lõpp-punktid, igaühe juures on märgitud vajalik ulatus (x-required-scope). Kui see juhend ja see dokument kunagi ei ühti, on dokument õige. Sa saad seda kasutada kliendi generaatoris või importida API tööriista.

Mis on kätte saadav — ja mis mitte

Ainult lõpp-punktid, mis on selgelt avaldatud, kuuluvad avalikku API-sse. Juhendav reegel on rikastada ja hallata, mitte hävitada:

Sa võid loetleda ja filtreerida tehinguid, määrata neile kategooria, teenusepakkuja, kliendi, projekti või isiku jaotused ning luua või uuendada teenusepakkujaid, kliente, projekte ja kategooriaid.
Sa ei saa kustutada teenusepakkujat, klienti, projekti või kategooriat läbi API. Andme eemaldamine, millele teised andmed viitavad, on otsus, mida skript ei peaks üksi tegema — need toimingud kuuluvad rakendusse.

Pangaühendused, arveldamine, meeskonna haldamine ja API võtme haldamine ei ole kunagi saadaval võtmega, olenemata ulatustest, mis tal on.

Kiiruspiirangud

Kolm piirangut kehtivad, ja päring peab rahuldama kõik:

Plaan	Lugemised/min ühe võtme kohta	Kirjutamised/min ühe võtme kohta	Päringud/min organisatsiooni kohta	Päevas, organisatsiooni kohta
Meeskond	120	30	120	10 000
Ettevõte	600	150	600	100 000

Organisatsiooni tasandi minutipiirang on see, mille ümber disainida. See on sama number, mis võtme piirang, seega üks võti, mis töötab täisvõimsusel, võib tarbida kogu organisatsiooni minuti — võtmete lisamine ei suurenda läbilaskevõimet. Kui sa jooksutad mitmeid integratsioone, siis tasakaalusta neid.

Iga vastus sisaldab X-RateLimit-Limit ja X-RateLimit-Remaining. 429 kannab Retry-After sekundites — austa seda; kohe uuesti proovimine on see, kuidas kiiruspiirang muutub katkestuseks.

Vead

Keeldumised kannavad stabiilset koodi, millele saad toetuda. Need, millega sa tõenäoliselt kokku puutud:

Kood	Tähendus
`api_key_invalid`	Vale vorming, tundmatu või vale saladus
`api_key_expired`	Aegunud — loo uus võti
`api_key_revoked`	Võti on tühistatud või vahetatud saladus on aegunud
`api_key_scope_missing`	Võtmel puudub ulatus, mida see lõpp-punkt vajab
`api_key_endpoint_not_published`	Lõpp-punkt ei kuulu avalikku API-sse
`api_key_rate_limited`	Üle piirangu — austa `Retry-After`

Päring, millel ei ole üldse võtit, saab tavalise 401 ilma koodita — käsitle ilma kehata 401 kui “Ma unustasin päise”.

Hea teada

Sinu võti ulatub täpselt ühte organisatsiooni — sellele, mille jaoks see anti. Seda ei saa suunata kuhugi mujale.
Kasutusnumbrid on näitlikud. “Viimati kasutatud” ja päringute arv vastavad “kas see on endiselt kasutuses?”, mitte arvelduse küsimustele.
Eelista API-d andmevoogude jaoks ja MCP Serverit kui kutsuja on AI assistent — sama tunnus, sama ulatus.