
API Export
API REST só de leitura para exportar os dados da sua conta elpizzero —encomendas, ementa, zonas, restaurante e métricas— para os seus próprios sistemas (CRM, BI, contabilidade, ecrãs, etc.). Inclui stream em direto (SSE) e webhooks de saída para reagir a alterações em tempo real.
- Base URL:
https://elpizzero.com/api/export - Auth:
Authorization: Bearer <token>em cada pedido. - Formato: JSON UTF-8. Montantes em cêntimos inteiros, datas em ISO-8601 UTC.
- Métodos:
GETem todos os recursos;POST/DELETEapenas para gerir os seus webhooks.
Autenticação
Bearer token no cabeçalho. Os tokens têm o formato elp_live_<32hex> ou elp_test_<32hex>.
Authorization: Bearer elp_live_3b8f0c2a1d4e5f6079a8b7c6d5e4f3a2
Gere e revogue tokens em Painel → Integrações → Chaves de API, escolhendo as respetivas permissões. O token é mostrado por completo uma única vez.
Permissões
| Scope | Ativa |
|---|---|
pedidos.leer | /pedidos, /pedidos/{id}, /pedidos/{id}/historial, /resumen |
carta.leer | /carta |
restaurante.leer | /restaurante, /zonas |
stream.escuchar | /stream (SSE) |
webhook.recibir | /webhooks (criação/remoção/listagem) |
Token sem o scope exigido → 403 alcance_insuficiente.
Ambientes
elp_live_ e elp_test_ leem os mesmos dados reais; não existe sandbox com dados simulados. O prefixo é apenas uma etiqueta para distinguir os seus tokens.
Rate limit
60 pedidos/min por token. Cabeçalhos em cada resposta: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Ao excedê-lo → 429 + Retry-After.
Convenções
- Dinheiro: cêntimos inteiros (
total_cents: 820= 8,20 €). Moeda num campo à parte (moneda: "EUR"). - Datas: ISO-8601 UTC com
Z(2026-05-31T20:42:15Z). - IDs: opacos, com prefixo de tipo —
ped_,prod_,cat_,tam_,grp_,opt_,zon_,rest_,itm_,wh_. Trate-os como strings. - Isolamento: cada token está associado a um restaurante; só devolve os dados desse restaurante.
- Paginação: por cursor (
cursor→paginacion.siguiente), ordem decrescente por predefinição.
Erros
Corpo uniforme + código HTTP coerente:
{
"ok": false,
"error": "Esta llave no tiene el alcance necesario: pedidos.leer",
"codigo": "alcance_insuficiente",
"doc": "https://elpizzero.com/docs/api/export#auth"
}
| HTTP | codigo |
|---|---|
| 401 | llave_ausente · llave_invalida · llave_revocada · llave_expirada |
| 403 | alcance_insuficiente · restaurante_inactivo |
| 400 | parametro_invalido (inclui valores_validos) |
| 404 | no_encontrado |
| 405 / 429 | metodo_invalido · limite_alcanzado |
Listar encomendas
Encomendas do restaurante, ordem id decrescente, paginação por cursor.
| Query | Tipo | Descrição |
|---|---|---|
estado | csv | pendienteconfirmadoen_preparacionlistoen_repartoentregadocancelado |
tipo | enum | repartorecogidamesa |
desde / hasta | ISO | Intervalo sobre creado_en (desde ≤ x < hasta). |
limite | int | 1–100, predefinição 25. |
cursor | string | Valor de paginacion.siguiente da página anterior. |
curl "https://elpizzero.com/api/export/pedidos?estado=entregado&desde=2026-05-01&limite=50" \
-H "Authorization: Bearer elp_live_..."
{
"datos": [ /* Objeto Pedido */ ],
"paginacion": { "limite":50, "siguiente":"ni", "anterior":null, "total_aprox":494 }
}
cursor = paginacion.siguiente até ser null para extrair todo o histórico.Obter uma encomenda
Devolve o Objeto Encomenda. {id} com prefixo, p. ex. ped_ni. 404 no_encontrado se não for sua.
Histórico de uma encomenda
{
"pedido_id": "ped_ni",
"eventos": [
{ "momento":"2026-05-31T20:42:15Z", "accion":"order_created",
"origen":"sistema", // sistema|panel|tpv|apk_recepcion|api
"usuario":null, "detalle":{} }
]
}
Ementa
Árvore completa categorias → produtos → tamanhos → grupos de opções → opções. ?solo_disponibles=true exclui o que está oculto/esgotado.
{
"restaurante_id":"rest_1", "restaurante_slug":"tu-restaurante",
"moneda":"EUR", "idioma_origen":"es", "generado_en":"2026-06-01T18:41:27Z",
"categorias": [{
"id":"cat_v", "nombre":"Pizzas", "activa":true,
"visible_dias":["lun","mar","mie","jue","vie","sab","dom"], "visible_horario":null,
"productos": [{
"id":"prod_3J", "nombre":"Margarita", "precio_cents":680,
"disponible":true, "destacado":false, "alergenos":["gluten","lacteos"],
"tamaños":[{ "id":"tam_11", "nombre":"mediana", "precio_cents":680, "predeterminado":true }],
"grupos_opcion":[{ "id":"grp_73", "nombre":"Extras", "requerido":false,
"min_seleccion":0, "max_seleccion":5,
"opciones":[{ "id":"opt_8", "nombre":"Extra queso", "precio_cents":120 }] }]
}]
}]
}
Zonas de entrega
Zonas com polígono em GeoJSON (coordenadas [lng, lat], anel fechado).
{ "datos": [{
"id":"zon_8", "nombre":"Albatera", "slug":"albatera",
"color":"#44c3e5", "tarifa_cents":250, "pedido_minimo_cents":2000,
"minutos_estimados":40, "activa":true,
"poligono":{ "tipo":"Polygon", "coordenadas":[[[-0.872,38.186], /* … */]] }
}] }
Restaurante
Ficha do restaurante: contacto, localização, horário por dia, branding, idiomas por canal, reputação. Sem dados fiscais sensíveis.
{
"id":"rest_1", "slug":"tu-restaurante", "nombre":"Tu Restaurante",
"moneda":"EUR", "zona_horaria":"Europe/Madrid",
"acepta_pedidos":true, "pedido_minimo_cents":500,
"horario":{ "viernes":[{"desde":"18:45","hasta":"23:30"}] /* … */ },
"contacto":{ "email":"…", "telefono":"…", "web":"…" },
"ubicacion":{ "direccion":"…", "ciudad":"…", "lat":38.14, "lng":-0.88 },
"branding":{ "logo_url":"…", "color_primario":"…", "galeria":[] },
"reputacion":{ "puntuacion":4.7, "votos":128 }
}
Resumo / métricas
periodo ∈ hoyayer7d30dmes_actual. Calculado no fuso horário do restaurante; exclui canceladas/rejeitadas.
{
"periodo":"30d", "desde":"2026-05-03T00:00:00+02:00", "hasta":"2026-06-02T00:00:00+02:00",
"zona_horaria":"Europe/Madrid",
"kpis":{ "pedidos_total":442, "pedidos_cancelados":52, "clientes_distintos":413,
"ventas_cents":893435, "ticket_medio_cents":2021, "moneda":"EUR" },
"mix_tipo":{ "reparto":268, "recogida":171, "mesa":3 },
"top_productos":[{ "producto_id":"prod_3K", "nombre":"Margarita", "unidades":150, "ventas_cents":113845 }]
}
Stream em direto (SSE)
Server-Sent Events. Envia eventos instantaneamente. Auth por query (o EventSource não suporta cabeçalhos). Reconexão nativa a cada 5 min através de Last-Event-ID; conexion.ping a cada ~25 s.
const es = new EventSource("https://elpizzero.com/api/export/stream?llave=elp_live_...");
es.addEventListener("pedido.nuevo", e => {
const ev = JSON.parse(e.data); // ev.datos.pedido = Objeto Pedido
console.log(ev.datos.pedido.numero);
});
Filtro opcional ?eventos=pedido.nuevo,pedido.aceptado. Tipos emitidos:
pedido.nuevopedido.aceptadopedido.rechazadopedido.estado_cambiadopedido.item_modificadopedido.entregadopedido.cancelado
Webhooks de saída
Alternativa pull → push: fazemos um POST ao seu URL quando uma encomenda muda. Apenas de saída.
curl -X POST "https://elpizzero.com/api/export/webhooks" \
-H "Authorization: Bearer elp_live_..." -H "Content-Type: application/json" \
-d '{"url":"https://tu-sistema.com/hook","nombre":"Mi CRM","eventos":["pedido.aceptado","pedido.entregado"]}'
{ "id":"wh_3", "url":"https://tu-sistema.com/hook",
"eventos":["pedido.aceptado","pedido.entregado"],
"secreto_firma":"a1b2…(64 hex, se muestra UNA vez)", "activo":true }
Eventos: os do stream + os carateres universais pedido.* e *. GET /webhooks lista · DEL /webhooks/{id} elimina.
Entrega e assinatura
Cada envio inclui estes cabeçalhos; o corpo é o mesmo objeto do stream:
X-Elp-Evento: pedido.aceptado
X-Elp-Id: 84213 # úsalo como clave de idempotencia
X-Elp-Firma: <hmac_sha256_hex(secreto, cuerpo_crudo)>
X-Elp-Intento: 1
// Verificación (Node)
const firma = crypto.createHmac("sha256", SECRETO).update(rawBody).digest("hex");
if (firma !== req.headers["x-elp-firma"]) return res.sendStatus(401);
X-Elp-Intento incremental). Deduplique por X-Elp-Id.Objeto Encomenda
Estrutura devolvida por /pedidos, /pedidos/{id}, pelo stream e pelos webhooks. Dados de cliente anonimizados no exemplo. direccion/mesa/entrega/fiscal são null quando não se aplicam.
{
"id":"ped_ni", "numero":"20260531-095",
"tipo":"reparto", // reparto|recogida|mesa
"estado":"en_preparacion",
"fuente":"web_publica", // web_publica|tpv|manual|admin
"creado_en":"2026-05-31T20:42:15Z", "aceptado_en":"…Z",
"entregado_en":null, "programado_para":null,
"restaurante":{ "id":"rest_1", "slug":"tu-restaurante", "nombre":"Tu Restaurante" },
"cliente":{ "nombre":"Juan Pérez", "telefono":"+34 600 000 000",
"email":"cliente@ejemplo.com", "consintio_marketing":false },
"direccion":{ "linea":"Calle Mayor 22", "codigo_postal":null, "pais":"ES", "lat":38.154, "lng":-0.880 },
"mesa":null,
"items":[{ "id":"itm_A3", "producto_id":"prod_3K", "nombre":"Margarita",
"tamaño":"mediana", "cantidad":1,
"precio_unitario_cents":720, "opciones_total_cents":120, "total_cents":840,
"estado_cocina":"pendiente",
"opciones":[{ "id":"opc_5", "grupo":"Extras", "nombre":"Extra queso", "cantidad":1, "precio_cents":120 }] }],
"totales":{ "moneda":"EUR", "subtotal_cents":840, "descuento_cents":0, "propina_cents":0,
"tarifa_reparto_cents":100, "impuestos_cents":85, "total_cents":1025,
"iva_desglose":[{ "tipo_porcentaje":10, "base_cents":940, "iva_cents":85 }] },
"pago":{ "metodo":"online", "estado":"pagado", "proveedor":"stripe",
"referencia_externa":"pi_3Td…", "pagos":[] },
"entrega":{ "repartidor_nombre":null, "zona_id":"zon_a", "zona_nombre":"Granja de Rocamora", "tarifa_cents":100 },
"fiscal":{ "factura_numero":"FA-1132/2026", "factura_fecha":"…Z", "factura_pdf":"https://…/factura.pdf" },
"instrucciones":null
}
Exemplo: ecrã de TV da cozinha
HTML+JS autónomo (só de leitura): cole o seu token, abra-o numa TV e as encomendas entram em direto pelo stream.