
API Export
elpizzero アカウントのデータ(注文、メニュー、配達エリア、レストラン情報、指標)を、CRM、BI、会計、ディスプレイなどの独自システムへエクスポートするための、読み取り専用の REST API です。変更をリアルタイムに受け取れるよう、ライブストリーム (SSE) と送信 webhook も備えています。
- ベース URL:
https://elpizzero.com/api/export - 認証: リクエストごとに
Authorization: Bearer <token>を指定します。 - 形式: JSON UTF-8。金額は整数のセント単位、日時は ISO-8601 UTC です。
- メソッド: すべてのリソースで
GET。POST/DELETEは webhook の管理にのみ使用します。
認証
ヘッダーによる Bearer token。token の形式は elp_live_<32hex> または elp_test_<32hex> です。
Authorization: Bearer elp_live_3b8f0c2a1d4e5f6079a8b7c6d5e4f3a2
token の生成と失効は パネル → 連携 → API キー で、権限を選択して行います。token が全文表示されるのは一度だけです。
権限
| Scope | 有効になる機能 |
|---|---|
pedidos.leer | /pedidos, /pedidos/{id}, /pedidos/{id}/historial, /resumen |
carta.leer | /carta |
restaurante.leer | /restaurante, /zonas |
stream.escuchar | /stream (SSE) |
webhook.recibir | /webhooks(登録/削除/一覧) |
必要なスコープのない token → 403 alcance_insuficiente。
環境
elp_live_ と elp_test_ は同じ実データを読み取ります。模擬データのサンドボックスはありません。プレフィックスは token を区別するためのラベルにすぎません。
レート制限
token ごとに 60 リクエスト/分。すべてのレスポンスに次のヘッダーが付きます:X-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Reset。超過した場合 → 429 + Retry-After。
規約
- 金額: 整数のセント単位(
total_cents: 820= 8,20 €)。通貨は別フィールドで示します(moneda: "EUR")。 - 日時:
Z付きの ISO-8601 UTC(2026-05-31T20:42:15Z)。 - ID: 種別プレフィックス付きの不透明な値 —
ped_、prod_、cat_、tam_、grp_、opt_、zon_、rest_、itm_、wh_。文字列として扱ってください。 - 分離: 各 token は 1 つのレストランに紐づき、そのレストランのデータのみを返します。
- ページネーション: cursor 方式(
cursor→paginacion.siguiente)。デフォルトの並び順は降順です。
エラー
統一されたボディ + 一貫した HTTP ステータスコード:
{
"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(valores_validos を含む) |
| 404 | no_encontrado |
| 405 / 429 | metodo_invalido · limite_alcanzado |
注文の一覧
レストランの注文を id の降順で返します。cursor によるページネーション。
| Query | Tipo | 説明 |
|---|---|---|
estado | csv | pendienteconfirmadoen_preparacionlistoen_repartoentregadocancelado |
tipo | enum | repartorecogidamesa |
desde / hasta | ISO | creado_en の範囲(desde ≤ x < hasta)。 |
limite | int | 1~100、デフォルトは 25。 |
cursor | string | 前のページの paginacion.siguiente の値。 |
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 で、null になるまで繰り返します。注文の取得
注文オブジェクトを返します。{id} にはプレフィックス付きの ID を指定します(例:ped_ni)。自分のものでない場合は 404 no_encontrado。
注文の履歴
{
"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":{} }
]
}
メニュー
カテゴリ → 商品 → サイズ → オプショングループ → オプション の完全なツリー。?solo_disponibles=true で非表示・品切れを除外します。
{
"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 }] }]
}]
}]
}
配達エリア
GeoJSON のポリゴンによる配達エリア(座標は [lng, lat]、閉じたリング)。
{ "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], /* … */]] }
}] }
レストラン
レストラン情報:連絡先、所在地、曜日ごとの営業時間、ブランディング、チャネルごとの言語、評価。機密性の高い税務データは含みません。
{
"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 }
}
サマリー / 指標
periodo ∈ hoyayer7d30dmes_actual。レストランのタイムゾーンで集計され、キャンセル・拒否された注文は除外されます。
{
"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 }]
}
ライブストリーム (SSE)
Server-Sent Events。イベントを即座にプッシュします。認証はクエリで行います(EventSource はヘッダーに対応していないため)。5 分ごとに Last-Event-ID によるネイティブ再接続が行われ、conexion.ping が約 25 秒ごとに送られます。
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);
});
任意のフィルター ?eventos=pedido.nuevo,pedido.aceptado。送信されるイベントの種類:
pedido.nuevopedido.aceptadopedido.rechazadopedido.estado_cambiadopedido.item_modificadopedido.entregadopedido.cancelado
送信 webhook
pull から push への代替手段:注文が変更されると、指定された URL に POST を送信します。送信のみです。
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 }
イベント:ストリームのイベント + ワイルドカード pedido.* と *。 GET /webhooks 一覧 · DEL /webhooks/{id} 削除。
配信と署名
各送信には次のヘッダーが含まれ、ボディはストリームと同じオブジェクトです:
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 が増加)。X-Elp-Id で重複を排除してください。注文オブジェクト
/pedidos、/pedidos/{id}、ストリーム、webhook が返す構造です。例の顧客データは匿名化されています。direccion/mesa/entrega/fiscal は該当しない場合 null になります。
{
"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
}
例:厨房 TV ディスプレイ
自己完結型の HTML+JS(読み取り専用):token を貼り付けて TV で開くと、ストリームを通じて注文がリアルタイムで届きます。