P4 Software
/
BarcoderX Español
Aplica a: BarcoderX Basic y Ultimate
Estado: Planificado, con una parte construida. Todavía no hay nada publicado y no hay nada que descargar. La primera parte, el servicio de etiquetas, está construida y probada: dibuja una etiqueta a partir de una plantilla y responde con un archivo PNG. Consulte El servicio de etiquetas. El resto de esta página enumera la primera versión de la API tal como está prevista. Las rutas y el comportamiento pueden cambiar hasta la primera versión. Después, la versión 1 cambia solo por adición.
El servidor de API que usted instala y ejecuta ofrece una API REST, de modo que un programa en cualquier lenguaje puede crear etiquetas, generar archivos e imprimir. Todo lo que guarda permanece en su propia base de datos. BarcoderX no aloja nada, y ninguna etiqueta, plantilla ni dato de impresión llega jamás a BarcoderX. La API vive bajo /api/v1 y un documento OpenAPI la describe. El editor de etiquetas usa la API y nada más. Los desarrolladores .NET cuentan además con BarcoderX.Client, un cliente tipado para cada operación.
La API pertenece al servidor que usted ejecuta. Un segundo host, el host de generación sin estado, ofrece solo las partes de generación. Vea más abajo.
Se generará una página de documentación a partir del documento OpenAPI, en inglés y en español, con un ejemplo de curl para cada operación. No usa ningún visor de documentación de terceros.
/api/v2, y la versión 1 seguiría funcionando al menos 12 meses después. Cada respuesta indica las versiones que admite el servidor, y una versión que se va a retirar lleva los encabezados Deprecation y Sunset.type que enlaza con la documentación, un code estable formado por BX y cuatro dígitos, un title y un detail en su idioma, una lista de diagnósticos que nombra el elemento y el lugar de la plantilla, y un ID de seguimiento. El idioma proviene del encabezado Accept-Language, luego del predeterminado de su servidor y luego del inglés.Idempotency-Key. BarcoderX guarda la respuesta durante 24 horas, de modo que repetir la solicitud devuelve la misma respuesta. La misma clave con un cuerpo distinto se rechaza con 422. Un duplicado que llega mientras el primero aún se ejecuta recibe 409.ETag. La actualización de una plantilla debe enviar If-Match. Un cambio hecho por otra persona responde 412, y la falta del encabezado responde 428.Retry-After./health/live y /health/ready no requieren inicio de sesión y no revelan ningún dato guardado.Los códigos de diagnóstico tienen la forma BX y cuatro dígitos. El primer dígito los agrupa por área:
| Rango | Área |
|---|---|
| 1000 a 1999 | Modelo y plantillas |
| 2000 a 2999 | Datos y expresiones |
| 3000 a 3999 | Gráficos, imágenes, fuentes, texto, exportación y el motor de etiquetas |
| 4000 a 4999 | Códigos de barras |
| 5000 a 5999 | Comandos e impresión |
| 6000 a 6999 | La API |
| 7000 a 7999 | El agente de impresión |
| 8000 a 8999 | El editor |
| 9000 a 9999 | Licencias |
Cada código tendrá su propia página de documentación en inglés y en español.
El servicio de etiquetas es un programa pequeño que usted ejecuta por su cuenta. Atiende estas rutas, todas bajo /api/v1 salvo las de salud:
| Ruta | Qué hace |
|---|---|
POST /render/png | Dibuja una etiqueta a partir de la plantilla del cuerpo y responde con un archivo PNG, en blanco y negro, gris o color, a la resolución que usted pida. |
POST /render/elements | Dibuja hasta 64 elementos de una plantilla, cada uno por separado, y responde con una imagen PNG de un bit de cada elemento que puede dibujar, para el editor. |
POST /commands?dialect=zpl | Escribe los comandos ZPL de una etiqueta, como texto simple o como JSON. |
POST /templates/validate, POST /templates/convert | Revisan una plantilla y enumeran cada hallazgo, o devuelven su texto canónico. |
GET /meta/limits | Los límites de este servicio. |
GET /meta/version | El producto, las versiones de la API y la compilación. |
GET /meta/licence | El estado de la licencia, sin la clave, y si la salida se marca. |
GET /meta/elements, GET /barcodes/symbologies | Los descriptores de elementos y los tipos de código de barras con sus opciones, para el editor. |
GET /printer-dialects, GET /printer-profiles | Los lenguajes de impresora y los perfiles de impresora. |
GET /health/live, GET /health/ready | {"status":"ok"}, sin clave. |
Estas rutas se describen en El servicio de etiquetas. Los errores son documentos de problema con un código del rango 6000 y, cuando una plantilla tiene problemas, la lista de ellos. Todavía no existe un documento OpenAPI, ni una plantilla guardada, ni otro formato de salida. Todo lo demás de esta página está planificado. Las rutas de la tabla de abajo son las previstas: por ejemplo, el POST /render previsto hace todos los formatos, y POST /render/png es su primera forma construida, junto con POST /render/elements.
Las rutas son relativas a /api/v1. Todo lo que aparece en la tabla está previsto para la primera versión, salvo que la última columna indique otra cosa. El inicio de sesión y los permisos están en Autenticación y acceso.
| Recurso | Para qué sirve | Métodos y rutas | Versión |
|---|---|---|---|
| Plantillas | Guardar, versionar, publicar, validar y convertir plantillas | GET, POST /templates; GET, PUT, DELETE /templates/{id}; GET /templates/{id}/versions; GET /templates/{id}/versions/{n}; POST /templates/{id}/versions/{n}/restore; POST /templates/{id}/publish; PUT /templates/{id}/draft; POST /templates/validate; POST /templates/convert | Primera |
| Archivos de plantilla | Mover una plantilla con sus fuentes e imágenes entre servidores | GET /templates/{id}/archive; POST /templates/import-archive | Primera |
| Generación y exportación | Crear un archivo de etiqueta a partir de una plantilla guardada o en línea y de datos. Formatos: PNG, JPG, PDF, SVG, PCX y HTML, y EPS más adelante. | POST /render; POST /render/elements; POST /render/thumbnail | Primera (EPS más adelante) |
| Comandos | Crear los comandos de impresora para una plantilla y datos | POST /commands | Primera |
| Trabajos por lotes | Ejecutar generaciones grandes en segundo plano | POST /jobs; GET /jobs/{id}; GET /jobs/{id}/output; DELETE /jobs/{id} | Primera |
| Trabajos de impresión | Enviar etiquetas a impresoras | POST /print-jobs; GET /print-jobs; GET /print-jobs/{id}; POST /print-jobs/{id}/cancel | Primera |
| Impresoras | Registrar impresoras, leer su estado, listar lenguajes de impresora y perfiles | GET, POST /printers; GET, PUT, DELETE /printers/{id}; GET /printers/{id}/status; GET /printer-dialects; GET /printer-profiles | Primera |
| Agentes | Listar agentes de impresión, iniciar el alta, revocar un agente | GET /agents; POST /agents/enrollments; DELETE /agents/{id} | Primera |
| Códigos de barras | Listar simbologías, verificar datos, crear un código de barras | GET /barcodes/symbologies; POST /barcodes/validate; POST /barcodes/encode | Primera |
| Recursos | Guardar fuentes e imágenes | GET, POST /assets/fonts; GET, POST /assets/images; GET /assets/{id}; GET /assets/{id}/content; DELETE /assets/{id} | Primera |
| Datos | Fuentes de datos guardadas, descubrimiento de campos y secuencias | GET, POST /data-sources; GET, PUT, DELETE /data-sources/{id}; POST /data-sources/infer-schema; GET, POST /sequences; POST /sequences/{id}/allocate | Primera |
| Expresiones | Listar funciones, verificar y probar expresiones, guardar macros | GET /expressions/functions; POST /expressions/validate; POST /expressions/evaluate; GET, POST /expressions/macros; PUT, DELETE /expressions/macros/{id} | Primera |
| Metadatos | Describir las propiedades de los elementos, los límites vigentes y el estado de la licencia | GET /meta/elements; GET /meta/limits; GET /meta/licence | Primera |
| Administración | Claves de API y el registro de auditoría | GET, POST /api-keys; DELETE /api-keys/{id}; GET /audit-events | Primera |
| Mantenimiento de impresoras | Pausar, reanudar, cortar, calibrar y operaciones similares | POST /printers/{id}/maintenance/{operation} | Más adelante |
Notas sobre algunas de ellas:
POST /barcodes/encode devuelve una imagen en cualquier formato ya publicado, elegido con el encabezado Accept, o un documento JSON con los datos de los módulos y detalles, o un URI de datos en base64. Pedir un formato que no se ha publicado responde 406. Los problemas de datos responden 422 con los diagnósticos.POST /commands y cada conjunto de etiquetas de un trabajo de impresión aceptan opciones que solo tiene un lenguaje de impresora. Una opción que el lenguaje no ofrece se rechaza con 422.POST /commands está construida en el servicio sin estado como POST /api/v1/commands?dialect=zpl. Recibe una plantilla completa y devuelve los comandos ZPL de toda la etiqueta como texto simple, con los mismos límites, lugares, límites de frecuencia y límite de tiempo que la dirección de la imagen. El perfil de impresora, los datos y las plantillas guardadas del /commands completo llegan después. Consulte Salida ZPL.GET /meta/licence muestra el estado de la licencia y nunca la clave. Consulte Ediciones y licencias./openapi/v1.json entrega el documento OpenAPI. No está bajo /api/v1.El host de generación sin estado es un host más pequeño del mismo motor. Está previsto como una imagen de contenedor para Linux x64 y Linux arm64. No tiene base de datos ni plantillas guardadas. Ofrece /render, /commands, /barcodes, /expressions y /meta, y recibe una plantilla completa en cada solicitud.
BarcoderX es un producto de P4 Software.
¿Te resultó útil esta página?