Hoppa till innehåll
https://api.frihet.io/v1 v1 — 2026-03-18

Frihets REST API

Programmatisk åtkomst till fakturor, kunder, utgifter, produkter och offerter. Utformad för integrationer som skalar.

85 OpenAPI paths 140 operations Cursor pagination Idempotency-Key HMAC-SHA256 webhooks

Interactive Explorer

Kodexempel

Deterministic payloads · Fictional fixture (Cafetería Lumen)

api.frihet.io/v1 JSON · UTF-8
SDK v1.2 · OpenAPI 3.1 · 85 paths · 140 ops
list-paid-invoices.ts Authorization: Bearer fri_...
                        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);
                      
HTTP/2 200 OK · 38 ms · X-RateLimit-Remaining: 599 Deterministic cursor pagination (nextCursor) · Cafetería Lumen
                      {
  "data": [
    {
      "id": "inv_01J8LUMEN0042",
      "documentNumber": "F-2026-0042",
      "status": "paid",
      "clientName": "Cafetería Lumen",
      "currency": "EUR",
      "subtotal": 1850,
      "taxAmount": 388.5,
      "total": 2238.5,
      "hashPreview": "sha256:9f86d081884c...b0f00a08"
    }
  ],
  "total": 42,
  "limit": 25,
  "offset": 0,
  "nextCursor": "cur_01J8LUMEN0043"
}
                    

Byggd för utvecklare

01

Partiella PATCH-uppdateringar

Uppdatera bara de fält du behöver. Partiella scheman validerade med Zod garanterar integritet.

02

Sökning och filter

Fulltextsökning med parameter ?q=. Fältmappning per resurs för exakta resultat.

03

Batchoperationer

Skapa upp till 50 resurser i en enda förfrågan. HTTP 207 multi-status svar.

04

Idempotensnycklar

Försök utföra förfrågningar igen på ett säkert sätt med Idempotency-Key-headern. Nycklar känns igen i 24 timmar.

05

Rate limit-headers

X-RateLimit-Limit, Remaining och Reset i varje svar. Planera därefter.

06

OpenAPI 3.1 Specifikation

Maskinläsbar specifikation på /openapi.yaml. 85 sökvägar, 66 scheman. Genererar SDK:er automatiskt.

07

Intelligenta slutpunkter

Affärskontext, månatliga sammanfattningar och kvartalsvisa skattedata via /context, /monthly, /quarterly.

08

Säker radering VeriFactu

Mjuk radering för fakturor och offerter som inte är utkast. Fullständig spårbarhet för spansk skatteefterlevnad.

Slutpunkter

Metod Sökväg
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

Webhook Security & Idempotency Blueprint

Three-step cryptographic webhook verification

HMAC-SHA256 · Idempotency-Key (24h)
01 X-Frihet-Signature

Timestamped signature header

Every delivery carries t=<unix_ts>,v1=<hex_digest> read against the unparsed raw body.

02 HMAC-SHA256(secret, rawBody)

Deterministic raw-body digest

Compute the SHA-256 HMAC over `${t}.${rawBody}` using your endpoint signing key.

03 timingSafeEqual

Constant-time verification

Compare equal-length buffers in constant time and reject stale replay timestamps.

verify-webhook.ts node:crypto · timingSafeEqual
import { createHmac, timingSafeEqual } from 'node:crypto';

export function verifyFrihetWebhook(rawBody: Buffer, header: string, signingKey: string): boolean {
  const parts = Object.fromEntries(header.split(',').map((kv) => kv.split('=')));
  if (!parts.t || !parts.v1) return false;

  const expected = createHmac('sha256', signingKey)
    .update(`${parts.t}.${rawBody.toString('utf8')}`)
    .digest('hex');

  const a = Buffer.from(parts.v1, 'hex');
  const b = Buffer.from(expected, 'hex');
  return a.length === b.length && timingSafeEqual(a, b);
}

Autentisering

Generera API-nycklar från Inställningar > API i din Frihet-panel. Inkludera din nyckel som Bearer token i Authorization-headern.

Authorization: Bearer fri_...
Idempotency-Key: idem_2026_0042

Börja integrera idag

API-åtkomst ingår i alla planer. Din API-nyckel är redo i Inställningar.

Kom igång gratis