Saltar al contenido

Crear un trabajo de impresión desde Base64

Decodifica un documento Base64 pequeño y crea el documento y el trabajo en una sola solicitud.

POST/api/v1/print-jobs/from-base64Versión de la API: v1operationId: createPrintJobFromBase64Ver como Markdown

Qué hace este método

Decodifica un documento Base64 pequeño y crea el documento y el trabajo en una sola solicitud.

Autenticación

Envía un token de corta duración en Authorization: Bearer <access_token>.

Permisos necesarios: print_jobs:write

Solicitud

URL de producción: https://public-api.cloudprint.me/api/v1/print-jobs/from-base64

Parámetros

NombreUbicaciónTipoObligatorioDescripciónRestricciones
Idempotency-KeyheaderstringnoClave estable generada por el cliente para que los reintentos devuelvan el resultado original sin crear duplicados.maxLength: 128
X-Request-IdheaderstringnoIdentificador opcional para rastrear la solicitud; CloudPrint devuelve un valor seguro en la cabecera de respuesta.maxLength: 128; example: "order-100045-attempt-1"

Cuerpo de la solicitud

Tipo de contenido: application/json

NombreTipoObligatorioDescripciónRestricciones
document_base64string (byte)Contenido completo del documento codificado en Base64, sin prefijo de data URL.
document_filenamestring | nullnoNombre de archivo usado para detectar el formato y facilitar el diagnóstico.example: "order-100045.pdf"
document_formatstring | nullnoFormato de impresión explícito, por ejemplo pdf o raw.enum: pdf, raw; example: "pdf"
document_raw_languagestring | nullnoLenguaje de comandos de los datos RAW, por ejemplo ZPL o EPL.enum: tspl, zpl, cpcl, escpos; example: null
printer_idstring (uuid)UUID estable de la impresora de destino en CloudPrint.
copiesintegernoNúmero de copias que CloudPrint solicita a la impresora.min: 1; max: 99; example: 1
intentstringnoFinalidad del trabajo de impresión; ayuda al diagnóstico y a elegir valores predeterminados adecuados.enum: document, shipping_label, product_label, invoice, packing_slip, a4_document, receipt; example: "shipping_label"
color_modestringnoModo de color solicitado; default usa la configuración de la impresora.enum: default, monochrome, color; example: "default"
duplex_modestringnoModo de impresión a una o dos caras solicitado.enum: default, simplex, duplex_long_edge, duplex_short_edge; example: "default"
media_width_mmnumber | nullnoAnchura solicitada del soporte o la etiqueta en milímetros.min: 1; max: 2000; example: 58
media_height_mmnumber | nullnoAltura solicitada del soporte o la etiqueta en milímetros.min: 1; max: 2000; example: 40
dpiinteger | nullnoResolución de impresión en puntos por pulgada; usa un valor compatible con la impresora.min: 72; max: 2400; example: 203
scale_modestringnoDetermina si el documento conserva su tamaño o se ajusta al soporte de destino.enum: none, fit; example: "none"
orientationstringnoOrientación de página solicitada; default usa la configuración de la impresora.enum: default, portrait, landscape; example: "default"
offset_x_mmnumbernoDesplazamiento horizontal de impresión en milímetros.min: -2000; max: 2000; example: 0
offset_y_mmnumbernoDesplazamiento vertical de impresión en milímetros.min: -2000; max: 2000; example: 0
margin_top_mmnumbernoMargen de impresión adicional en milímetros.min: 0; max: 2000; example: 0
margin_right_mmnumbernoMargen de impresión adicional en milímetros.min: 0; max: 2000; example: 0
margin_bottom_mmnumbernoMargen de impresión adicional en milímetros.min: 0; max: 2000; example: 0
margin_left_mmnumbernoMargen de impresión adicional en milímetros.min: 0; max: 2000; example: 0

Ejemplos de solicitud

cURL

bash
curl -sS https://public-api.cloudprint.me/api/v1/print-jobs/from-base64 \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: order-100045-label' \
  -d '{
    "document_base64": "JVBERi0xLjQK...",
    "document_filename": "order-100045.pdf",
    "printer_id": "11111111-1111-4111-8111-111111111111",
    "copies": 1,
    "intent": "shipping_label",
    "media_width_mm": 58,
    "media_height_mm": 40,
    "dpi": 203
  }'

Respuesta

Estado HTTP: 201 — Recurso creado.

Campos de respuesta

NombreTipoObligatorioDescripciónRestricciones
print_job_idstring (uuid)UUID estable del trabajo de impresión; guárdalo para consultar el estado y solicitar soporte.
document_idstring (uuid)UUID estable devuelto después de subir correctamente el documento.
document_mime_typestringTipo MIME del documento proporcionado.example: "application/pdf"
document_formatstringFormato de impresión explícito, por ejemplo pdf o raw.enum: pdf, raw; example: "pdf"
document_raw_languagestring | nullLenguaje de comandos de los datos RAW, por ejemplo ZPL o EPL.enum: tspl, zpl, cpcl, escpos; example: null
printer_idstring (uuid)UUID estable de la impresora de destino en CloudPrint.
statusstringEstado actual del recurso o flujo; usa los valores enum específicos del método.enum: pending, reserved, printing, printed, failed, cancelled; example: "pending"
copiesintegerNúmero de copias que CloudPrint solicita a la impresora.min: 1; max: 99; example: 1
intentstringFinalidad del trabajo de impresión; ayuda al diagnóstico y a elegir valores predeterminados adecuados.enum: document, shipping_label, product_label, invoice, packing_slip, a4_document, receipt; example: "shipping_label"
color_modestringModo de color solicitado; default usa la configuración de la impresora.enum: default, monochrome, color; example: "default"
duplex_modestringModo de impresión a una o dos caras solicitado.enum: default, simplex, duplex_long_edge, duplex_short_edge; example: "default"
media_width_mmnumber | nullAnchura solicitada del soporte o la etiqueta en milímetros.min: 1; max: 2000; example: 58
media_height_mmnumber | nullAltura solicitada del soporte o la etiqueta en milímetros.min: 1; max: 2000; example: 40
dpiinteger | nullResolución de impresión en puntos por pulgada; usa un valor compatible con la impresora.min: 72; max: 2400; example: 203
scale_modestringDetermina si el documento conserva su tamaño o se ajusta al soporte de destino.enum: none, fit; example: "none"
orientationstringOrientación de página solicitada; default usa la configuración de la impresora.enum: default, portrait, landscape; example: "default"
offset_x_mmnumberDesplazamiento horizontal de impresión en milímetros.min: -2000; max: 2000; example: 0
offset_y_mmnumberDesplazamiento vertical de impresión en milímetros.min: -2000; max: 2000; example: 0
margin_top_mmnumberMargen de impresión adicional en milímetros.min: 0; max: 2000; example: 0
margin_right_mmnumberMargen de impresión adicional en milímetros.min: 0; max: 2000; example: 0
margin_bottom_mmnumberMargen de impresión adicional en milímetros.min: 0; max: 2000; example: 0
margin_left_mmnumberMargen de impresión adicional en milímetros.min: 0; max: 2000; example: 0
created_atstring (date-time)Marca de tiempo ISO 8601 registrada por CloudPrint.
reserved_atstring | null (date-time)Marca de tiempo ISO 8601 registrada por CloudPrint.
started_atstring | null (date-time)Marca de tiempo ISO 8601 registrada por CloudPrint.
completed_atstring | null (date-time)Marca de tiempo ISO 8601 registrada por CloudPrint.
failure_reasonstring | nullMotivo legible por máquina o de diagnóstico registrado cuando falla la impresión.

Ejemplo de respuesta

json
{
  "print_job_id": "11111111-1111-4111-8111-111111111111",
  "document_id": "11111111-1111-4111-8111-111111111111",
  "document_mime_type": "application/pdf",
  "document_format": "pdf",
  "document_raw_language": null,
  "printer_id": "11111111-1111-4111-8111-111111111111",
  "status": "pending",
  "copies": 1,
  "intent": "shipping_label",
  "color_mode": "default",
  "duplex_mode": "default",
  "media_width_mm": 58,
  "media_height_mm": 40,
  "dpi": 203,
  "scale_mode": "none",
  "orientation": "default",
  "offset_x_mm": 0,
  "offset_y_mm": 0,
  "margin_top_mm": 0,
  "margin_right_mm": 0,
  "margin_bottom_mm": 0,
  "margin_left_mm": 0,
  "created_at": "2026-08-06T12:00:00Z",
  "reserved_at": "2026-08-06T12:00:00Z",
  "started_at": "2026-08-06T12:00:00Z",
  "completed_at": "2026-08-06T12:00:00Z",
  "failure_reason": "string"
}

Errores

Estado HTTPDescripción
400Comprueba el formato y los parámetros.
401Falta la autenticación o no es válida.
403El token no tiene permisos suficientes.
409La solicitud entra en conflicto con el estado actual.
413El cuerpo supera el tamaño permitido.
415El formato no es compatible.
422Uno o varios campos no son válidos.
429Se superó el límite de solicitudes; respeta Retry-After.
500Error interno de CloudPrint.

Recomendaciones de integración

  • Base64 aumenta el tamaño de la solicitud; para documentos grandes usa una carga multipart o una URL HTTPS pública.
  • Reserva esta opción para recibos o etiquetas pequeños.
  • Aplica las mismas reglas de idempotencia y seguimiento.

Documentación relacionada

Guías para integrar CloudPrint, conectar el agente local y operar flujos de impresión.