Saltar al contenido
DocumentaciónAbrir panel
Explorar guías
IntegracionesIntegrar directamente con REST

Integrar directamente con REST

Usa la misma autorización y las mismas propuestas revisadas desde tu POS o adaptador HTTP.

Abrir Markdown

Servidor 1.0 · MCP 2025-11-25 · Claves Bearer por negocio

En esta página

Base y equivalencias con MCP

Base REST autenticada
https://zoydelivery.com/api/integrations/v1
Método y ruta relativaOperación MCP
GET /schemacatalog_schema
GET /catalog?limit=100&offset=0catalog_read
GET /menu/library?q=catalog_library_read
POST /menu/librarycatalog_library_update
POST /catalog/previewcatalog_preview
POST /catalog/bulk/previewcatalog_bulk_preview
POST /catalog/configuration/analyzecatalog_migration_analyze
POST /catalog/configuration/previewcatalog_configuration_preview
POST /catalog/applycatalog_apply
GET /imports y GET /imports/:importIdimports_list / import_get
POST /documents/preparedocument_prepare
POST /documents/jobsdocument_job_create
GET /documents/jobs y GET /documents/jobs/:jobIddocument_jobs_list / document_job_get
POST /documents/jobs/:jobId/retry o /canceldocument_job_retry / document_job_cancel

Envía Authorization: Bearer y Content-Type: application/json en las escrituras. REST responde JSON HTTP; /api/mcp espera mensajes JSON-RPC del protocolo MCP. No intercambies los cuerpos ni añadas un tenant al payload para cambiar de negocio.

Guarda un plan antes de aplicar

Terminal privada; lote.json contiene el ejemplo de catálogo
umask 077
curl --fail-with-body \
  https://zoydelivery.com/api/integrations/v1/catalog/preview \
  -H "Authorization: Bearer ${ZOY_MENU_TOKEN:?Define la clave privada}" \
  -H "Content-Type: application/json" \
  --data-binary @lote.json \
  --output plan.json

plan.json incluye datos privados del catálogo. Comprueba errors, before/after, moneda y disponibilidad. Conserva importId y revision del plan que revisaste; no sustituyas la revisión por una más reciente sin volver a preparar el cambio.

Aplicación e idempotencia

aplicar.json: sustituye los valores por los del plan revisado
{
  "importId": "UUID_DEL_PLAN_REVISADO",
  "expectedRevision": "REVISION_DEL_PLAN"
}
Ejecuta solo después de autorizar el cambio
curl --fail-with-body \
  https://zoydelivery.com/api/integrations/v1/catalog/apply \
  -H "Authorization: Bearer ${ZOY_MENU_TOKEN:?Define la clave privada}" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: pos-export-2026-10-lote-01" \
  --data-binary @aplicar.json \
  --output recibo.json

En MCP idempotencyKey es un argumento de catalog_apply y document_job_create; en REST viaja en la cabecera Idempotency-Key. Usa 8–128 caracteres alfanuméricos con : . _ - y conserva la clave y el cuerpo para reintentos del mismo intento lógico.