Factuarea API

API de Factuarea

L'API REST de Factuarea per automatitzar el teu SaaS de facturació multi-tenant per a empreses espanyoles.

L'API REST de Factuarea exposa recursos de facturació (clients, productes, factures, pressupostos, factures proforma, albarans, factures recurrents, factures de compra) sobre HTTPS amb autenticació per API key. Tota la superfície pública viu a https://api.factuarea.com/v1 i retorna JSON. Cada recurs s'identifica per un id opac (un string UUID v7).

Inici ràpid

Sol·licita accés beta

L'API està actualment en beta privada. Escriu a info@factuarea.com seguint les instruccions de Sol·licitar accés beta. Si la teva empresa ja està a la llista d'accés, salta al pas següent.

Crea la teva primera API key

Obre Dashboard → Developers → API Keys i crea una clau amb els scopes que necessitis (per exemple invoices:read,clients:read per començar). Copia el secret només un cop — no el podràs tornar a veure.

Tria l'entorn Test per obtenir una clau fact_test_ que opera sobre un sandbox aïllat sense efectes en el món real. Crea contra ell primer i després crea una clau fact_live_ per passar a producció. Consulta Mode de prova i sandbox.

Verifica la teva clau

Abans de res, confirma que la clau funciona. GET /v1/account introspecciona la credencial — retorna l'empresa a què pertany, el pla, i els scopes i el tier de límit de peticions de la mateixa clau (necessita account:read):

curl https://api.factuarea.com/v1/account \
  -H "Authorization: Bearer fact_test_xxxxxxxxxxxxxxxxxxxxxxxx"

✅ Hauries de veure un 200 amb una instantània d'account:

{
  "data": {
    "object": "account",
    "company": {
      "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a01",
      "name": "Acme Soluciones SL",
      "tax_id": "B12345678"
    },
    "plan": { "slug": "empresario", "name": "Empresario" },
    "api_key": {
      "id": "01931b3e-7c4a-7f2e-9a8b-4d6e7f8a9b0c",
      "name": "Sandbox integration",
      "prefix": "fact_test_3pXnR2Vb",
      "scopes": ["account:read", "clients:read", "invoices:read"],
      "tier": "starter"
    }
  }
}

Si obtens 401 invalid_api_key, torna a comprovar el valor. L'array scopes et diu exactament què pot fer aquesta clau — una crida posterior que falli amb 403 insufficient_scope no en té algun.

Fes la teva primera petició de dades

Ara llista un recurs real. GET /v1/clients retorna un embolcall estàndard amb data (resultats), has_more i next_cursor (paginació per cursor):

curl https://api.factuarea.com/v1/clients \
  -H "Authorization: Bearer fact_test_xxxxxxxxxxxxxxxxxxxxxxxx"

Llest per emetre la teva primera factura de principi a fi? Segueix l' Inici ràpid. Si reps un error, cerca'l a Errors pel code retornat.

Configura webhooks (opcional)

Si la teva integració necessita reaccionar a esdeveniments (factura pagada, pressupost acceptat, etc.), configura un webhook endpoint signat amb HMAC SHA256. Consulta Webhooks.

Què cobreix l'API

Disseny del contracte

L'API segueix els patrons que esperaries d'un proveïdor modern:

  • Identificadors opacs — la clau id porta un string UUID v7 en lloc d'un enter incremental. Consulta Paginació per a la semàntica del cursor.
  • Errors normalitzats — cada error retorna un embolcall amb type, code, message, param, doc_url i request_id. Consulta Errors.
  • Idempotency keys — suportades a cada POST per evitar duplicats en els reintents. Consulta Idempotència.
  • Límits de peticions per tier — quotes per minut i mensuals, amb capçaleres X-RateLimit-* a cada resposta. Consulta Límits de peticions.
  • Versionat per URL/v1/*. Els canvis incompatibles disparen /v2/* amb una política de deprecació documentada. Consulta Versionat.
  • Webhooks amb rotació de doble secret — HMAC SHA256, reintent exponencial amb fins a 8 intents. Consulta Webhooks.

SDKs

Oferim SDKs oficials de TypeScript i PHP (@factuarea/sdk i factuarea/factuarea-php) amb reintents, idempotència, paginació per cursor, errors tipats i verificació de webhooks integrats. Si el teu llenguatge no està cobert, qualsevol client HTTP estàndard (curl, Postman, axios, requests, Guzzle) funciona — l'API és REST pla sobre JSON.

L'API REST pública complementa el client web de Factuarea (app.factuarea.com) — no el reemplaça. Les operacions que l'API no exposa (gestió de plans, branding, configuració fiscal global de l'empresa) segueixen vivint a l'app.

En aquesta pàgina