Bazinis URL
https://freebillgen.com/api/v1Autentifikacija
Kiekvienai užklausai naudojamas Bearer raktas. Sukurkite jį skiltyje Nustatymai → API raktai, suteikite jam reikiamas skaitymo/rašymo apimtis pagal išteklių, nustatykite neprivalomą galiojimo pabaigą ir siųskite su kiekviena užklausa:
Authorization: Bearer <jūsų-api-raktas>Raktas visada pasiekia tik jūsų paskyros duomenis, ir galite jį bet kada atšaukti.
Ką galite daryti
- Skaityti sąskaitas, klientus, įmones, mokėjimus ir pasikartojančius grafikus
- Juos kurti ir atnaujinti (rašymo API - Pro)
- Gauti PVM ir įsiskolinimų ataskaitas JSON formatu
- Registruoti webhook adresus sąskaitų ir mokėjimų įvykiams (Pro)
- Idempotency-Key antraštė rašymo užklausoms - pakartota užklausa niekada nesuveikia dukart
- Žymeklio puslapiavimas per links.next, reguliuojamas per per_page (daugiausia 100)
Susitarimai
- Idempotentiškumas
- Siųskite Idempotency-Key antraštę bet kuriai kūrimo ar veiksmo užklausai; pakartota užklausa grąžina pirminį rezultatą, o ne suveikia dukart.
- Puslapiavimas
- Sąrašų užklausos puslapiuojamos žymekliu - sekite links.next (arba perduokite ?cursor=...) ir reguliuokite ?per_page= (daugiausia 100).
- Pinigai
- Sumos yra JSON eilutės su dviem skaitmenimis po kablelio, pvz. "121.00", kad išvengtumėte slankiojo kablelio apvalinimo.
- ID
- Kiekvienas išteklius adresuojamas neskaidriu id, niekada ne nuosekliu numeriu.
Pavyzdys: gauti savo sąskaitų sąrašą
curl https://freebillgen.com/api/v1/invoices \
-H "Authorization: Bearer $FREEBILLGEN_API_KEY"Atidaryti pilną interaktyvią API dokumentaciją →
Klausimai apie sąskaitų API
Ar sąskaitų API nemokamas?
Taip - skaitymo API įeina į nemokamą planą be jokio mokesčio. Rašymo API (sąskaitų kūrimas ir atnaujinimas) bei webhooks yra neprivalomo Pro priedo dalis.
Kaip autentifikuotis?
Sukurkite Bearer raktą skiltyje Nustatymai -> API raktai, priskirkite jam skaitymo/rašymo apimtis pagal išteklių ir siųskite kaip Authorization: Bearer antraštę su kiekviena užklausa. Raktai apriboti jūsų paskyra ir gali būti atšaukti ar nustatytas jų galiojimo terminas.
Ar galiu kurti sąskaitas programiškai?
Taip, per rašymo API, kuris yra Pro priedo dalis. Jis parengia tokias pačias reikalavimus atitinkančias sąskaitas kaip ir žiniatinklio programa, su nuosekliu numeravimu ir PVM apdorojimu serverio pusėje.
Kaip išvengti pasikartojančių sąskaitų pakartojus užklausą?
Siųskite Idempotency-Key antraštę kūrimo užklausoje. Jei užklausa pakartojama su tuo pačiu raktu, API grąžina pirminį rezultatą, o ne sukuria antrą sąskaitą.