Arendajadokumentatsioon
Arve sisse, makse-QR välja — API kaudu
Neli ust sama maagia juurde: REST-API, MCP-server tehisintellekti agentidele, e-posti integratsioon ja veebirakendus. Üks konto, üks API-võti, üks tokenite saldo — 1 token lehe kohta, ükskõik millist ust kasutad.
Kolme sammuga valmis
Loo API-võti
Logi rakendusse sisse ja loo võti jaotises „API ja integratsioonid“. See algab gsk_live_ ja seda näidatakse täpselt üks kord — hoia see kindlas kohas. 10 tasuta tokenit on juba kontol.
Vali uks
REST sinu süsteemile, MCP sinu tehisintellekti agendile, e-post olemasolevatele saatmisprotsessidele — või lihtsalt veebirakendus. Võti on kõikjal sama.
Saada arveid
Dokument sisse, vastuseks maksetandmed ja GiroCode — PDF-ide puhul ka templiga PDF. Iga vastus näitab kasutatud ja allesjäänud tokeneid.
Autentimine: üks võti kõigeks
REST-API ja MCP-server autendivad sama GiroSnapi API-võtmega bearer-tokenina. Eraldi „MCP-võtit“ ei ole — rakenduse gsk_live_-võti ongi see üks võti:
Authorization: Bearer gsk_live_...
Võtmeid saab luua ja tühistada ainult rakenduses (sisselogitud seanss) — lekkinud võti ei saa kunagi uusi võtmeid luua. Võtme teksti ei saa pärast loomist enam kunagi kätte.
REST-API
JSON või multipart, kuni 12 MB dokumendi kohta (JPG, PNG, WEBP, PDF). Kiireim algus on kõik-ühes-lõpp-punkt:
curl -X POST https://www.girosnap.eu/api/v1/invoices \ -H "Authorization: Bearer gsk_live_..." \ -F "file=@rechnung.pdf"
- POST
/api/v1/invoicesKõik ühes: maksetandmed + QR, PDF-ide puhul ka templiga PDF. - POST
/api/v1/extractAinult maksetandmete eraldamine (ilma QR-i ja templita). - POST
/api/v1/qrAinult QR — valmis maksetandmetest (ilma eraldamiseta) või dokumendist. - POST
/api/v1/stampGiroCode’i tembeldamine PDF-ile. - GET
/api/v1/balanceTokenite saldo, hoiatusläve ja pakettide päring (tasuta). - POST
/api/v1/checkoutOtse makstava Stripe’i lingi loomine tokenipaketile.
Kõik parameetrid, vastuseformaadid ja veakoodid — koos „try it out“ võimalusega otse brauseris: Ava interaktiivne API viide
MCP-server
MCP (Model Context Protocol) on avatud standard, millega tehisintellekti agendid (nt Claude) kasutavad väliseid tööriistu. Meie MCP-server annab sinu agendile GiroSnapi tööriistakastina: ta pildistab arve, kutsub tööriista ja saab GiroCode’i või templiga PDF-i otse oma töövoogu tagasi.
Lihtsaim tee — Claude (veeb ja töölaud): Seaded → Konnektorid → „Lisa kohandatud konnektor“, pane nimeks „GiroSnap“ ja kleebi see URL koos võtmega. Jäta OAuthi väljad tühjaks:
https://www.girosnap.eu/api/mcp?key=GIROSNAP_API_KEY
See URL sisaldab sinu API-võtit — käsitle seda nagu parooli ja ära jaga seda.
Ühendamine: sisesta serveri URL ja anna API-võti kaasa Authorization-päisena — sama seadistus töötab Claude’is, IDE-agentides ja sinu oma SDK-agentides:
{
"mcpServers": {
"girosnap": {
"type": "http",
"url": "https://www.girosnap.eu/api/mcp",
"headers": {
"Authorization": "Bearer gsk_live_..."
}
}
}
}GIROSNAP_API_KEY on sinu tavaline gsk_live_-võti rakendusest — eraldi MCP-võtit ei ole.
Tööriistad ükshaaval
extract_invoice1 token/lehtLoeb arvefotolt või PDF-ist saaja, IBANi, BICi, summa (sentides) ja selgituse. Vajalik ainult siis, kui sinu agent ei saa või ei tohi arvet ise lugeda.
create_payment_qr1 token/lehtLoob skannitava EPC/GiroCode’i — pildi, SVG ja toorandmetena. Võtab valmis maksetandmed (kiireim tee, ilma eraldamiseta) või dokumendi.
stamp_invoice_pdf1 token/lehtTembeldab GiroCode’i PDF-arvele — vabale alale või lisatud lehele; allkirjastatud PDF-id ja e-arved jäävad puutumata ning saavad saatelehe.
get_token_balancetasutaPraegune tokenite saldo, hoiatusläve näidik, pakettide loend ja laadimislink.
buy_tokenstasutaLoob otse makstava Stripe Checkouti lingi tokenipaketile — pärast makset lisatakse tokenid automaatselt.
Nipp: kui sinu agent teab maksetandmeid juba (ta ju nägi arvet), annab ta need lihtsalt payment-väljana create_payment_qr või stamp_invoice_pdf tööriistale — meie poolel ei käivitu siis mingit eraldamist ja vastus tuleb kõige kiiremini.
E-posti integratsioon
Saada arved lihtsalt e-postiga — täiesti ilma koodita. Fotodele vastame GiroCode’iga kirja sisus; PDF-id tulevad templiga tagasi manustena, kasvõi mitu ühe kirjaga.
- Registreeri oma saatja-aadress rakenduses jaotises „API ja integratsioonid“.
- Klõpsa kirjas oleval kinnituslingil — valmis.
- Saada arved (PDF, JPG, PNG, WEBP) töötlusaadressile ja oota vastust.
Kuni 10 manust kirja kohta, igaüks 12 MB. Vastus näitab alati kasutatud ja allesjäänud tokeneid; kui saldo jääb väikseks, on laadimislink kaasas.
Veebirakendus ja ajalugu
Rakendus ise on neljas uks: laadi üles, kontrolli, tembelda — otse brauseris. Ja ükskõik millisest uksest arve sisse tuleb: kõik talletatakse sinu ajalukku, kus QR, PDF-id ja kulud on igal ajal kättesaadavad.
Tokenid ja hinnad
Üks reegel, kõikjal: 1 token lehe kohta (QR valmis andmetest loeb ühe lehena). Uued kontod alustavad 10 tasuta tokeniga; laadimine käib Stripe’i kaudu — rakenduses, POST /api/v1/checkout kaudu või buy_tokens tööriistaga.
Kui saldo jääb väikseks, hoiatame e-postiga; nulli juures peatub töötlus kõigil ustel (ühtegi tehisintellekti teenust ei kutsuta) ja iga vastus kannab laadimislinki.
Aus arveldus: kui töötlus ebaõnnestub meie poolel, tagastatakse token. Kui mudel töötas, aga ei suutnud arvet lugeda, jääb see kasutatuks.
Vead
Kõik vead kasutavad sama ümbrikku — masinloetav code, arusaadav message ja tokenite puudumisel (HTTP 402) laadimislink otse vastuses:
{
"error": {
"code": "insufficient_tokens",
"message": "Not enough tokens for this operation.",
"needed": 3,
"balance": 1,
"checkoutUrl": "https://www.girosnap.eu/app?screen=tokens"
}
}Olulised koodid: insufficient_tokens (402), unreadable (422, mudel töötas — token kasutatud), extraction_failed (502, tagastatud), unsupported_media (415), file_too_large (413). Täielik loend interaktiivses viites.
Logi sisse, loo võti, saada esimene arve — 10 tasuta tokenit kaasas.