Documentación
Referencia de la API
Todos los endpoints de la versión v1. Autenticación:Authorization: Bearer <API_KEY> en todas las peticiones (ver Autenticación). Cuerpos en JSON; fechas en DD-MM-YYYY o YYYY-MM-DD; importes como cadenas decimales con dos decimales.
Facturas
| Endpoint | Descripción |
|---|
POST /v1/create | Registra una factura (alta). Devuelve síncronamente uuid, huella encadenada, qr (PNG Base64) y url de cotejo AEAT. Detalle. |
POST /v1/create_bulk | Registra un lote de facturas en una única transacción atómica (todo o nada), en orden. |
POST /v1/cancel | Emite un registro de anulación de una factura, identificada por serie + numero + fecha_expedicion. Detalle. |
PUT /v1/modify | Emite un registro de subsanación: reenvía la factura con los datos corregidos hacia la AEAT. |
Consultas
| Endpoint | Descripción |
|---|
GET /v1/status | Estado de un registro (?serie=&numero=): PENDIENTE, ENVIADO, ACEPTADO, RECHAZADO, ERROR, con errores AEAT si los hay. |
GET /v1/registros | Listado de registros de la instalación, para conciliación y paneles. |
GET /v1/health | Comprueba la API key: estado de la instalación, NIF vinculado y entorno AEAT activo. |
Validación de destinatarios
| Endpoint | Descripción |
|---|
POST /v1/validate/nif | Pre-valida un NIF/CIF/NIE contra el censo de la AEAT (VNifV2). Detalle. |
POST /v1/validate/vat | Pre-valida un número de IVA intracomunitario contra VIES. |
Webhooks
| Endpoint | Descripción |
|---|
POST /v1/client-webhooks | Registra un endpoint receptor. Devuelve el secret HMAC (visible solo en esa respuesta). |
GET /v1/client-webhooks | Lista los webhooks de la instalación. |
GET /v1/client-webhooks/{id} | Detalle de un webhook. |
PUT /v1/client-webhooks/{id} | Modifica URL, activa/desactiva o rota el secret. |
DELETE /v1/client-webhooks/{id} | Elimina el webhook. |
Especificación OpenAPI: la API está descrita con OpenAPI 3.1. Consulta la referencia interactiva (visor autoalojado) o descarga elopenapi.json para generar clientes o importar la colección en tu herramienta.