Unidades

Todas las unidades no definidas específicamente son unidades de puntos.

 

Acción

La "Acción" es un parámetro de llamada URL, que permite al cliente solicitar información o cambiar elementos de la cola actual interactuando con la impresora.

La URL base para acceder a él es http://[IP\]:\[PORT\]/. Los datos devueltos por las llamadas están en formato XML. Cada llamada se realiza utilizando el método HTTP GET. Los parámetros se añaden a la URL base de forma normal. El primer parámetro debe ser siempre el comando (?action).

La mayoría de los comandos de acción requieren que se pase un UUID. Este es el ID del trabajo, obtenido de la impresora.

Autentique sus solicitudes de API Web proporcionando un token. Es preferible que los tokens se envíen en la cabecera HTTP Authorization de sus solicitudes salientes. Sin embargo, también puede pasar tokens en todas las llamadas a la Web API como un parámetro llamado token.

 

Llamadas a la acción

printerInfo

Acción de solicitud sin parámetros que devuelve un archivo XML con toda la información de la impresora.

jobInfo

Acción de petición con UUID como parámetro que nos devuelve toda la información del trabajo solicitado.

moveUpJob

El cliente da un UUID como parámetro y la impresora mueve este elemento una posición hacia arriba en la cola.

moveDownJob

El cliente da un UUID como parámetro y la impresora mueve este elemento una posición hacia abajo en la cola.

moveJob

El cliente da un UUID como parámetro y la impresora mueve este elemento en una posición especificada de la cola.

enableJob

El cliente da un UUID y un estado Enable (siendo posible: true, false, yes, no...) como parámetro y la impresora pondrá el ítem habilitado o no para ser impreso.

startQueue

Comienza la acción de imprimir. No hay que dar más parámetros. La impresora sólo imprimirá aquellos elementos con el parámetro Activar en True.

stopQueue

No hay más parámetros que dar. La impresora detiene todos los procesos de impresión.

addJob

Acción en el método POST. El cliente debe dar un tipo de Esquema, la posición de Activación, y el Título del nuevo trabajo, y entonces la impresora toma esa información y añade un nuevo trabajo con esta información.

jobPreview

Devuelve un png codificado dentro del XML.

setJobParameters

Modifica los parámetros (esquema, altura programada, copias) de un trabajo existente.

exportJob

Descargar un trabajo como .xjb

exportScheme

Descargue uno o varios esquemas en formato .zip

importScheme

Importe uno o varios esquemas desde un archivo .zip

quit

Intenta cerrar el servidor de impresión


Cada acción devolverá al menos un XML con un RequestStatus, que devuelve un "Ok" para acciones bien ejecutadas o un "Error" para acciones mal ejecutadas. En ambos casos, el XML también incluirá un RequestMessage, que nos informará del tipo de acción o error que hemos realizado.

Para acciones bien ejecutadas:

<MoveDownJob UUID="384b96be-369a-4224-b459-12090c62091f" RequestStatus="OK" RequestMessage="Job 384b96be-369a-4224- b459-12090c62091f moved"/>


Para acciones mal ejecutadas:

<MoveUpJob UUID="38b96be-369a-4224-b459-12090c62091f" RequestStatus="Error" RequestMessage="Job 38b96be-369a-4224- b459-12090c62091f not found"/>


Funciona en todas las acciones, no sólo con moveUpJob y moveDownJob.

printerInfo

El parámetro base para obtener la información de la impresora es: ?action=printerInfo. El uso de este parámetro devolverá un XML con el siguiente formato.

<PrinterInfo Printer=(string) Status=(string) Active=\[Yes|No\] ClusterID=(string) DefaultScheme=(string) PendingSize=(float) SelectedSize=(float) DoneSize=(float) Workstation=(string)>
<JobList> 
<Job UUID=(string) StatusID=(string) Status=(string) Enabled=(String) LastError=(string)> 
... 
</Job> 
... 
</Job> 
</JobList> 
<Schemes> <Scheme Name=(string)/> 
</Schemes>
<Layouts> <Layout Name=(string)/> 
</Layouts> 
</PrinterInfo>


En la acción PrinterInfo podemos ver los siguientes parámetros devueltos en el XML:

  • Impresora es el nombre de la impresora a la que hacemos referencia. Un ejemplo sería Impresora="Impresora genérica".
  • El estado es una cadena con siete opciones: error, inactivo, activo, cancelando, borrando, terminado y cargando.
    • Error para indicar al cliente que hay un error con este trabajo.
    • Ralentí si la impresora está esperando a que se imprima un elemento habilitado.
    • Activo para el trabajo se está imprimiendo.
    • Cancelando aparece en el momento en que la impresora está cancelando cualquier trabajo.
    • Borrando mientras se está borrando cualquier trabajo.
    • Terminado es para trabajos terminados.
    • Cargando para cualquier trabajo, que se está cargando para ser impreso.
  • Activa sólo puede ser sí o no. Indica si la cola está activa para imprimir cualquier elemento habilitado o inactiva para imprimir.
  • DefaultScheme se refiere al esquema que utilizaremos por defecto en cada impresión. En nuestro caso tendrá dos opciones:
<Scheme Name="197 - Carta_Pigment_i1_10012012"/>

o

<Scheme Name="Esquema tipus Roland"/>
  • PendingSize se refiere a la longitud que está pendiente, en la cola, de ser impresa.
  • SelectedSize se refiere a la longitud que ha sido seleccionada, en la cola, para ser impresa.
  • DoneSize se refiere a la longitud que se ha impreso y aún aparece en la cola.
  • Estación de trabajo es el nombre del ordenador que está ejecutando printEngine.

Dentro de la acción, tenemos un JobList y los Esquemas.

  • JobList muestra todos los trabajos que hemos enviado a la impresora, dando toda la información que incluye. La información sobre los trabajos se explica en la siguiente sección.
  • Los esquemas incluyen todos los esquemas que tenemos en la impresora.
  • Esquema: El esquema es una configuración para una Impresora. Una impresora puede incluir más de un esquema, y normalmente lo hace. Por eso debemos elegir el esquema cuando enviamos un trabajo a imprimir.

jobInfo

El parámetro base para obtener la información del trabajo es: ?action=jobInfo&UUID=(string). Usando este parámetro devolverá un XML con el siguiente formato. Cuando el cliente utiliza la acción; printerInfo, devuelve toda la información de la impresora incluyendo todos los trabajos, por lo que el jobInfo se incluye en el printerInfo.

<Job UUID=(string) StatusID=(string) Status=(string) Enabled=(String) 
 LastError=(string) RequestStatus=(OK|Error)> 
 <Title>ORD-12065295-5A150_002.xjb</Title> 
 <Scheme>197 - Carta_Pigment_i1_10012012</Scheme> 
 <TempPath> 
 C:\Documents and Settings\All Users\Documentos 
 \neoPrintEngine\Jobs\Generic Printer\384b96be-369a-4224- 
 b459-12090c62091f 
 </TempPath> 
 <PageSpace>0.000000</PageSpace> 
 <MultichannelOverprint>no</MultichannelOverprint> 
 <Hour>1367924640</Hour> 
 <LastActivity>1372418206</LastActivity> 
 <PrintWidth>4535.520000</PrintWidth> 
 <PrintHeight>750.289134</PrintHeight> 
 <Pages Count="3"> 
 <Page Id="0" SourceWidth="0.000000" SourceHeight="0.000000" 
 Width="4535.520000" Height="112.320000" DoneHeight="0.000000" 
 ProgrammedHeight="112.320000" Flags="0"/> 
 <Page Id="1" SourceWidth="0.000000" SourceHeight="0.000000" 
 Width="4535.433071" Height="566.929134" DoneHeight="0.000000" 
 ProgrammedHeight="566.929134" Flags="1"/> 
 <Page Id="2" SourceWidth="0.000000" SourceHeight="0.000000" 
 Width="4535.520000" Height="71.040000" DoneHeight="0.000000" 
 ProgrammedHeight="71.040000" Flags="0"/> 
 </Pages> 
 <PrintedLength>19.200000</PrintedLength> 
 <LastErrorMessage/> 
 </JobInfo>

Los parámetros que obtenemos del Job son los siguientes.

  • UUID del trabajo del que pedimos información.
  • Estado ya explicado en la sección printerInfo.
  • StatusID es el código interno para referirse a cada estado.
    • Error -1
    • Inactivo 0
    • Activo 1
    • Cancelando 2
    • Borrando 3
    • Finalizado 4
    • Cargando 5
  • Habilitado tiene dos opciones (sí|no). Este parámetro muestra si el trabajo está habilitado para imprimirse cuando la impresora está activa.
  • LastError como dice, muestra el último error ocurrido en el trabajo.
  • RequestStatus ya explicado.

Después, el XML incluye toda la información específica del trabajo. Que es:

  • Título: Este es el título del trabajo en el que estamos trabajando.
  • Esquema: Este es el esquema que la impresora utilizará para este trabajo.
  • TempPath: Es la ruta donde se guarda el documento que estamos imprimiendo.
  • Hora: Es la hora a la que se ha registrado el trabajo, en la marca de tiempo.
  • ÚltimaActividad: Es la hora de la última actividad de impresión, también en timestamp.
  • PrintWidth: Este es el ancho del trabajo que la impresora va a imprimir.
  • AlturaImpresión: Esta es la Altura del trabajo que la impresora va a imprimir.
  • Páginas: Muestra el número de páginas del trabajo.
    • Id: Número de páginas.
    • AnchoFuente: ---------------
    • AltoFuente: ----------------
    • Ancho: ---------------------
    • Altura: --------------------
    • DoneHeight: Altura ya impresa.
    • ProgrammedHeight: Altura que se va a imprimir.
  • Longitud impresa: Longitud total impresa de este trabajo.
  • LastErrorMessage: Como dice, el último error ocurrido en este trabajo.

jobPreview

El parámetro base para obtener información del trabajo es: ?action=jobPreview&UUID=(string)[&Size=(integer)]. Size es el tamaño de la vista previa en píxeles. Usando este parámetro devolverá un XML con el siguiente formato.

<JobPreview UUID=(string) Format="png">
(Data...)
 </JobPreview>

Los parámetros que obtenemos del Job son los siguientes.

  • UUID del trabajo del que pedimos información.
  • Formato de la imagen incrustada. Por defecto es png.

Después, el XML incluye toda la información específica del trabajo. Que es:

  • Datos codificados en Base64.

deleteJob

Los parámetros base para eliminar un trabajo son: ?action=borrarTrabajo&UUID=(cadena).

Parámetros:
UUID(obligatorio): Cadena que hace referencia a un número alfanumérico único que corresponde a un trabajo único.

Usando esta acción devolverá un XML con un RequestStatus y un RequestMessage.

moveUpJob

Los parámetros base para mover un trabajo hacia arriba en la cola son:?action=moveUpJob&UUID=(cadena).

Parámetros:
UUID(obligatorio): Cadena que hace referencia a un número alfanumérico único que corresponde a un trabajo único.

Usando esta acción devolverá un XML con un RequestStatus y un RequestMessage.

moveDownJob

Los parámetros base para mover un trabajo hacia abajo en la cola son: ?action=moveDownJob&UUID=(cadena).

Parámetros:
UUID(obligatorio): Cadena que hace referencia a un número alfanumérico único que corresponde a un trabajo único.

Usando esta acción devolverá un XML con un RequestStatus y un RequestMessage.

moveJob

Los parámetros base para mover un trabajo a la posición especificada en la cola son: action=moveJob&UUID=(cadena)&Position=(número).

Parámetros:
UUID(obligatorio): Cadena que hace referencia a un número alfanumérico único que corresponde a un trabajo único.

Posición(obligatorio): Número que especifica la nueva posición en la lista.

Usando esta acción devolverá un XML con un RequestStatus y un RequestMessage.

enableJob

Los parámetros base para habilitar un trabajo son: ?action=habilitarTrabajo&UUID=(cadena)&Habilitar=(sí|no).

Parámetros:
UUID(obligatorio): Cadena que hace referencia a un número alfanumérico único que corresponde a un trabajo único.
Habilitar(obligatorio): Cadena con dos opciones. Sí o No. Indica si el trabajo está preparado para ser impreso, o no.

Usando esta acción devolverá un XML con un RequestStatus y un RequestMessage.

startQueue

El parámetro base para iniciar la cola es: ?action=startQueue.

Usando esta acción devolverá un XML con un RequestStatus y un RequestMessage.

addJob

Los parámetros base para añadir un nuevo trabajo son ?action=addJob&Scheme=(string)&Enabled=(true|false)&Title=(string)&Layout=(string)&Width=(float)&Height=(float)...


Parámetros:

  • Esquema (obligatorio): Cadena; El esquema para el nuevo trabajo.
  • Título (Obligatorio): Cadena; El título para el nuevo trabajo.
  • Habilitado (Obligatorio): Booleano; Si el nuevo trabajo estará habilitado.
  • Layout (Opcional): Cadena; El nombre del diseño (tal como lo proporciona printerInfo) para el nuevo trabajo.
  • Anchura (Opcional): Flotador;
  • Altura (opcional): Flotador;
  • Copias (Opcional): Entero; El nuevo número de copias del trabajo.
  • OriginX (Opcional): Float; La nueva posición de origen programada del trabajo, cualquier unidad.
  • OriginY (Opcional): Float; La nueva posición de origen programada del trabajo, cualquier unidad.
  • OutputFileName (Opcional): Controladores con formatos de archivo de salida, nombre del archivo para el trabajo de impresión específico .
  • ComputerID: Cadena; El nombre del ordenador cliente que envía el trabajo.
  • UserID: Cadena; El nombre de usuario del ordenador cliente.

Adicionalmente a este parámetro GET, un parámetro adicional llamado 'file' tendrá que ser enviado vía POST en la misma petición.

setJobParameters

Los parámetros base para cambiar los parámetros de un trabajo ?action=setJobParameters&UUID=(string)&Scheme=(string)[&ProgrammedHeight=(float)&Copies=(integer)]...

Parámetros:

  • UUID (Obligatorio): Cadena; El UUID del trabajo.
  • Esquema (Obligatorio): Cadena; El nuevo esquema del trabajo.
  • ProgrammedHeight (Opcional): Float; La nueva altura programada del trabajo, cualquier unidad.
  • Copias (Opcional): Entero; El nuevo número de copias del trabajo.
  • OriginX (Opcional): Float; La nueva posición de origen programada del trabajo, cualquier unidad.
  • OriginY (Opcional): Float; La nueva posición de origen programada del trabajo, cualquier unidad.
  • OutputFileName (Opcional): Controladores con formatos de archivo de salida, nombre del archivo para el trabajo de impresión específico.

Si se omite ProgrammedHeight o copies, su valor no se modifica.

Usando esta acción devolverá un XML con un RequestStatus y un RequestMessage.

exportJob

Los parámetros base para exportar un trabajo son: ?action=exportJob&UUID=(cadena)[&base64=(si|(sin valor))]. Si base64 se establece en cualquier valor, la respuesta se devolverá en base64 dentro de un XML con el siguiente formato.

<JobExport UUID=(string)>
(Base64 encoded Data...)
 </JobExport>

Si no se envía el parámetro base64, el .xjb se enviará a través de HTTP como un archivo normal.

exportScheme

Los parámetros para exportar un esquema son: ?action=exportScheme&Name=(cadena). La API devolverá un archivo .zip en caso de éxito o 404 Scheme not Found en caso de error.

Parámetros:

  • Nombre (obligatorio): Cadena; El nombre del esquema a exportar. Puede utilizar el valor especial "*" para exportar todos los esquemas.

importScheme

Los parámetros para importar un esquema son: ?action=importScheme&[Force=(yes|no value)]. Además, uno o varios archivos ".zip" deberán enviarse mediante parámetros POST, como archivos.

Parámetros:

  • Force (Opcional): Si el parámetro force se pasa con cualquier valor y el esquema dentro del archivo zip ya existe, se borrará antes de importar. Esta bandera es potencialmente peligrosa, úsela con precaución.

La respuesta para esta API tendrá la siguiente sintaxis:

<?xml version="1.0" encoding="utf-8"?>
<ImportScheme>
  <Scheme Name="First Scheme"/>
  ...
  <Scheme Name="Last Scheme" Status="Error"/>
</ImportScheme>

Una lista <Scheme> de todos los esquemas que se han intentado importar, si un esquema no se puede importar tendrá el valor de Estado "Error". Esto puede deberse a que el esquema ya existe, puede utilizar &Force=yes para eliminar el esquema original antes de importar.

abandone

Intenta cerrar el Servidor de Impresión, si el Servidor de Impresión está imprimiendo o copiando no se cerrará.

El único parámetro necesario para cerrar el servidor de impresión es: ?action=quit.

Artículos relacionados:

Webhooks del servidor de impresión