Frihetin REST API
Ohjelmallinen pääsy laskuihin, asiakkaisiin, kuluihin, tuotteisiin ja tarjouksiin. Suunniteltu skaalautuville integraatioille.
Suunniteltu kehittäjille
Osittaiset PATCH-päivitykset
Päivitä vain tarvitsemasi kentät. Zodilla validoidut osittaiset skeemat takaavat eheyden.
Haku ja suodattimet
Koko tekstin haku parametrilla ?q=. Kenttien kartoitus resurssin mukaan tarkkojen tulosten saamiseksi.
Batch-operaatiot
Luo jopa 50 resurssia yhdellä pyynnöllä. HTTP 207 multi-status -vastaukset.
Idempotenssiavaimet
Yritä pyyntöjä uudelleen turvallisesti Idempotency-Key-otsikolla. Avaimet tunnistetaan 24 tunnin ajan.
Nopeusrajoitusotsikot
X-RateLimit-Limit, Remaining ja Reset jokaisessa vastauksessa. Suunnittele sen mukaisesti.
OpenAPI 3.1 -määritys
Koneellisesti luettava määritys osoitteessa /openapi.yaml. 16 polkua, 18 skeemaa. Generoi SDK:t automaattisesti.
Älykkäät päätepisteet
Liiketoimintaympäristö, kuukausittaiset yhteenvedot ja neljännesvuosittaiset verotiedot kautta /context, /monthly, /quarterly.
Turvallinen VeriFactu-poisto
Pehmytpoisto laskuille ja ei-luonnosmuotoisille tarjouksille. Täysi jäljitettävyys Espanjan verosäännösten noudattamiseksi.
Päätepisteet
| Method | Path |
|---|---|
| GET | /v1/invoices |
| POST | /v1/invoices |
| PATCH | /v1/invoices/:id |
| DELETE | /v1/invoices/:id |
| POST | /v1/invoices/batch |
| GET | /v1/clients |
| POST | /v1/clients |
| GET | /v1/expenses |
| POST | /v1/expenses |
| GET | /v1/products |
| GET | /v1/quotes |
| GET | /v1/context |
| GET | /v1/monthly |
| GET | /v1/quarterly |
| GET | /openapi.yaml |
Koodiesimerkit
import { Frihet } from '@frihet/sdk';
const apiKey = process.env.FRIHET_API_KEY;
if (!apiKey) throw new Error('Set FRIHET_API_KEY before running this example');
const frihet = new Frihet({ apiKey });
// Follow each page's nextCursor until all paid invoices have been read.
let cursor: string | undefined;
do {
const page = await frihet.invoices.list({ status: 'paid', limit: 25, cursor });
for (const invoice of page.data) {
console.log(invoice.documentNumber, invoice.total);
}
cursor = page.nextCursor;
} while (cursor);
Todennus
Luo API-avaimia kohdasta Asetukset > API Frihet-hallintapaneelissasi. Sisällytä avaimesi Bearer-tunnuksena Authorization-otsikkoon.
Authorization: Bearer fri_...
Aloita integrointi tänään
API-käyttö sisältyy kaikkiin tilauksiin. API-avaimesi on valmis Asetuksissa.
Aloita ilmaiseksi