Przejdź do treści
Nowe VERI*FACTU wchodzi w 2027 r., a elpizzero jest już gotowe. Zobacz, jak Porozmawiajmy?Partners: para agencias
API Export Tylko odczyt · api@elpizzero.com

API Export

REST API tylko do odczytu do eksportu danych Twojego konta elpizzero — zamówień, karty dań, stref, restauracji i metryk — do Twoich własnych systemów (CRM, BI, księgowość, ekrany itp.). Zawiera strumień na żywo (SSE) i wychodzące webhooki, które pozwalają reagować na zmiany w czasie rzeczywistym.

Zakres. To API nie tworzy ani nie modyfikuje zamówień. Przyjmowanie zamówień do elpizzero nie jest publiczne i nie jest tu opisane: włączamy je dla konkretnego konta po weryfikacji. Jeśli potrzebujesz czegoś takiego, napisz do nas na api@elpizzero.com.

Uwierzytelnianie

Token Bearer w nagłówku. Tokeny mają format elp_live_<32hex> lub elp_test_<32hex>.

Authorization: Bearer elp_live_3b8f0c2a1d4e5f6079a8b7c6d5e4f3a2

Tokeny generujesz i unieważniasz w Panel → Integracje → Klucze API, wybierając ich uprawnienia. Token jest wyświetlany w całości tylko raz.

Uprawnienia

ScopeUmożliwia
pedidos.leer/pedidos, /pedidos/{id}, /pedidos/{id}/historial, /resumen
carta.leer/carta
restaurante.leer/restaurante, /zonas
stream.escuchar/stream (SSE)
webhook.recibir/webhooks (dodawanie/usuwanie/lista)

Token bez wymaganego scope → 403 alcance_insuficiente.

Środowiska

elp_live_ i elp_test_ odczytują te same prawdziwe dane; nie ma piaskownicy z danymi symulowanymi. Prefiks jest tylko etykietą ułatwiającą rozróżnianie tokenów.

Rate limit

60 żądań/min na token. Nagłówki w każdej odpowiedzi: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset. Po przekroczeniu → 429 + Retry-After.

Konwencje

Błędy

Jednolite ciało odpowiedzi + spójny kod HTTP:

{
  "ok": false,
  "error": "Esta llave no tiene el alcance necesario: pedidos.leer",
  "codigo": "alcance_insuficiente",
  "doc": "https://elpizzero.com/docs/api/export#auth"
}
HTTPcodigo
401llave_ausente · llave_invalida · llave_revocada · llave_expirada
403alcance_insuficiente · restaurante_inactivo
400parametro_invalido (zawiera valores_validos)
404no_encontrado
405 / 429metodo_invalido · limite_alcanzado

Lista zamówień

GET /pedidos

Zamówienia restauracji, sortowane malejąco wg id, paginacja kursorowa.

QueryTipoOpis
estadocsvpendienteconfirmadoen_preparacionlistoen_repartoentregadocancelado
tipoenumrepartorecogidamesa
desde / hastaISOZakres dla creado_en (desde ≤ x < hasta).
limiteint1–100, domyślnie 25.
cursorstringWartość paginacion.siguiente z poprzedniej strony.
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 }
}
Iteruj z cursor = paginacion.siguiente, aż wartość będzie null, aby pobrać całą historię.

Pobranie zamówienia

GET /pedidos/{id}

Zwraca Obiekt Zamówienie. {id} z prefiksem, np. ped_ni. 404 no_encontrado, jeśli nie jest Twoje.

Historia zamówienia

GET /pedidos/{id}/historial
{
  "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":{} }
  ]
}

Karta dań

GET /carta

Pełne drzewo kategorie → produkty → rozmiary → grupy opcji → opcje. ?solo_disponibles=true pomija pozycje ukryte/wyprzedane.

{
  "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 }] }]
    }]
  }]
}

Strefy dostaw

GET /zonas

Strefy z wielokątem w formacie GeoJSON (współrzędne [lng, lat], zamknięty pierścień).

{ "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], /* … */]] }
}] }

Restauracja

GET /restaurante

Karta restauracji: kontakt, lokalizacja, godziny otwarcia wg dni, branding, języki wg kanału, reputacja. Bez wrażliwych danych podatkowych.

{
  "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 }
}

Podsumowanie / metryki

GET /resumen?periodo=30d

periodo ∈ hoyayer7d30dmes_actual. Obliczane w strefie czasowej restauracji; wyklucza anulowane/odrzucone.

{
  "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 }]
}

Strumień na żywo (SSE)

GET /stream

Server-Sent Events. Wysyła zdarzenia natychmiast. Uwierzytelnianie w query (EventSource nie obsługuje nagłówków). Natywne ponowne połączenie co 5 min przez Last-Event-ID; conexion.ping co ok. 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);
});

Opcjonalny filtr ?eventos=pedido.nuevo,pedido.aceptado. Emitowane typy:

pedido.nuevopedido.aceptadopedido.rechazadopedido.estado_cambiadopedido.item_modificadopedido.entregadopedido.cancelado

Wychodzące webhooki

Alternatywa pull → push: wysyłamy POST na Twój URL, gdy zamówienie się zmieni. Tylko wychodzące.

POST /webhooks
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 }

Zdarzenia: te ze strumienia + symbole wieloznaczne pedido.* i *.  GET /webhooks lista · DEL /webhooks/{id} usuwa.

Dostarczanie i podpis

Każde wywołanie zawiera te nagłówki; treść to ten sam obiekt co w strumieniu:

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);
W razie błędu ponawiamy (X-Elp-Intento rośnie). Deduplikuj po X-Elp-Id.

Obiekt Zamówienie

Struktura zwracana przez /pedidos, /pedidos/{id}, strumień i webhooki. Dane klienta w przykładzie są zanonimizowane. direccion/mesa/entrega/fiscal mają wartość null, gdy nie dotyczą.

{
  "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
}

Przykład: ekran TV w kuchni

Samodzielny HTML+JS (tylko odczyt): wklej swój token, otwórz na telewizorze, a zamówienia będą napływać na żywo przez strumień.

→ Otwórz przykład TV w kuchni