API REST Frihet
Programowy dostęp do faktur, klientów, wydatków, produktów i ofert. Zaprojektowana dla integracji, które skalują.
Stworzona dla deweloperów
Częściowe aktualizacje PATCH
Aktualizuj tylko te pola, których potrzebujesz. Częściowe schematy zweryfikowane za pomocą Zod gwarantują integralność.
Wyszukiwanie i filtry
Wyszukiwanie pełnotekstowe z parametrem ?q=. Mapowanie pól według zasobu dla precyzyjnych wyników.
Operacje wsadowe
Utwórz do 50 zasobów w jednym żądaniu. Odpowiedzi HTTP 207 multi-status.
Klucze idempotencji
Bezpiecznie ponawiaj żądania z nagłówkiem Idempotency-Key. Klucze są rozpoznawane przez 24 godziny.
Nagłówki limitu szybkości
X-RateLimit-Limit, Remaining i Reset w każdej odpowiedzi. Planuj odpowiednio.
Specyfikacja OpenAPI 3.1
Specyfikacja czytelna maszynowo w /openapi.yaml. 16 ścieżek, 18 schematów. Generuje SDK automatycznie.
Punkty końcowe inteligencji
Kontekst biznesowy, miesięczne podsumowania i kwartalne dane podatkowe poprzez /context, /monthly, /quarterly.
Bezpieczne usuwanie VeriFactu
Soft delete dla faktur i ofert, które nie są robocze. Pełna identyfikowalność dla zgodności podatkowej w Hiszpanii.
Punkty końcowe
| 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 |
Przykłady kodu
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);
Uwierzytelnianie
Generuj klucze API z Ustawień > API w swoim panelu Frihet. Dołącz swój klucz jako token Bearer w nagłówku Authorization.
Authorization: Bearer fri_...
Zacznij integrować już dziś
Dostęp do API wliczony we wszystkie plany. Twój klucz API jest gotowy w Ustawieniach.
Zacznij za darmo