HP Embedded Capture Device License 500 Plus E-LTU Guia de referência

Marca: HP

Modelo: Embedded Capture Device License 500 Plus E-LTU

Tipo: Guia de referência

Este manual também é adequado para

HP Embedded Capture (HP EC)

Guia de referência da API

Versão 1.5.0

L.P.

Microsoft, Windows e Windows NT são marcas

comerciais registradas da Microsoft

Corporation nos EUA.

Março de 2016

Software confidencial de computador. É

necessária uma licença válida da HP para

posse, uso ou cópia. Em conformidade com o

FAR 12.211 e 12.212, o Software Comercial de

Computador, a Documentação de Software de

Computador e os Dados Técnicos para Itens

Comerciais estão licenciados pelo governo dos

Estados Unidos, de acordo com a licença

comercial padrão do fornecedor.

As informações aqui contidas estão sujeitas a

alterações sem prévio aviso. As únicas

garantias de produtos e serviços HP estão

definidas na declaração de garantia expressa

que os acompanha. Nada aqui deve ser

interpretado como constituição de garantia

adicional. A HP não se responsabiliza por

omissões ou erros técnicos ou editoriais que

possam estar aqui contidos.

Conteúdo

1 Introdução à API ............................................................................................................................................ 1

1.1 Modos básico e avançado ................................................................................................................................ 1

1.1.1 API básica ................................................................................................................................... 1

1.1.2 API avançada .............................................................................................................................. 1

1.2 Acessando a API em um dispositivo (%API_URL%) ......................................................................................... 1

1.2.1 Codificação XML ......................................................................................................................... 2

1.2.2 Validação de XSD ........................................................................................................................ 2

1.2.3 Códigos de resposta ................................................................................................................... 2

2 Segurança de API ........................................................................................................................................... 3

2.1 Contas de administrador e API ........................................................................................................................ 3

2.1.1 Conta de administrador ............................................................................................................. 3

2.1.1.1 Conta de usuário “apiuser” ................................................................................... 3

2.1.2 Usando a API sem autenticação ................................................................................................. 3

2.2 Autenticação de acesso básico ........................................................................................................................ 4

3 API compatível .............................................................................................................................................. 5

3.1 Serviços de gráficos e trabalhos ..................................................................................................................... 5

3.1.1 Put job (carregar trabalho) ........................................................................................................ 5

3.1.2 View job (exibir trabalho) ........................................................................................................... 9

3.1.3 Delete job (excluir trabalho) .................................................................................................... 11

3.1.4 Get files (obter arquivos) ......................................................................................................... 12

3.1.5 Set purge settings (definir configurações de limpeza) ........................................................... 13

3.2 Serviços de configuração .............................................................................................................................. 15

3.2.1 Get device info (obter informações do dispositivo) ................................................................ 15

3.2.2 Get device status (obter status do dispositivo) ...................................................................... 16

3.2.3 Get solution info (obter informações da solução) .................................................................. 17

3.2.4 Get solution status (obter status da solução) ......................................................................... 18

3.2.5 Wake up (reativar) .................................................................................................................... 19

3.2.6 Cancel scan (cancelar digitalização) ........................................................................................ 19

3.2.7 Reset Solution (redefinir solução) ........................................................................................... 20

3.3 Serviços de extensibilidade ........................................................................................................................... 21

3.3.1 Set button (definir botão) ........................................................................................................ 21

3.3.2 Remove button (remover botão) ............................................................................................. 22

3.4 Serviços de acessibilidade ............................................................................................................................. 23

3.4.1 Set API Password (definir senha da API) ................................................................................. 23

iii

3.4.2 Block Embedded Capture UI (bloquear interface de usuário do EC) ....................................... 24

3.4.3 Unblock Embedded Capture UI (desbloquear interface de usuário do EC) ............................. 25

3.5 Serviços de log ............................................................................................................................................... 26

3.5.1 Enable log (ativar log) .............................................................................................................. 26

3.5.2 Get log (obter log) .................................................................................................................... 27

3.5.3 Disable log (desativar log) ....................................................................................................... 27

4 API avançada ............................................................................................................................................... 29

4.1 Serviços de gráficos e trabalhos ................................................................................................................... 29

4.1.1 Set graph (definir gráfico) ........................................................................................................ 29

4.1.2 Append graph (anexar gráfico) ................................................................................................ 34

4.1.3 View graph (exibir gráfico) ....................................................................................................... 35

4.1.4 Clear graph (limpar gráfico) ..................................................................................................... 36

4.1.5 Modify node (modificar nó) ...................................................................................................... 37

4.1.6 Delete node (excluir nó) ........................................................................................................... 38

5 Apêndice I: Referência de configurações da API .............................................................................................. 40

5.1 Configurações de navegação ........................................................................................................................ 40

5.2 Configurações de digitalização ..................................................................................................................... 40

5.3 Metadados e opções personalizadas ............................................................................................................ 41

5.4 Notificações ................................................................................................................................................... 41

5.5 Destinos ......................................................................................................................................................... 42

6 Apêndice II: Códigos de erro .......................................................................................................................... 44

Lista de tabelas

Tabela 3-1 Put job (carregar trabalho) ................................................................................................................................. 5

Tabela 3-2 View job (exibir trabalho) ................................................................................................................................... 9

Tabela 3-3 Delete job (excluir trabalho) ............................................................................................................................ 11

Tabela 3-4 Get files (obter arquivos) ................................................................................................................................. 12

Tabela 3-5 Set purge settings (definir configurações de limpeza) ................................................................................... 13

Tabela 3-6 Get device info (obter informações do dispositivo) ........................................................................................ 15

Tabela 3-7 Get device status (obter status do dispositivo) ............................................................................................... 16

Tabela 3-8 Valores possíveis de status do ADF ................................................................................................................. 16

Tabela 3-9 Get solution info (obter informações da solução) ........................................................................................... 17

Tabela 3-10 Get solution status (obter status da solução) ............................................................................................... 18

Tabela 3-11 Valores possíveis de status de navegação .................................................................................................... 18

Tabela 3-12 Wake up (reativar) .......................................................................................................................................... 19

Tabela 3-13 Valores possíveis de status do dispositivo .................................................................................................... 19

Tabela 3-14 Cancel scan (cancelar digitalização) .............................................................................................................. 19

Tabela 3-15 Reset Solution (redefinir solução) ................................................................................................................. 20

Tabela 3-16 Set button (definir botão) .............................................................................................................................. 21

Tabela 3-17 Remove button (remover botão) ................................................................................................................... 22

Tabela 3-18 Set API Password (definir senha da API) ........................................................................................................ 23

Tabela 3-19 Bloquear dispositivo ...................................................................................................................................... 24

Tabela 3-20 Desbloquear dispositivo ................................................................................................................................ 25

Tabela 3-21 Enable log (ativar log) .................................................................................................................................... 26

Tabela 3-22 Get log (obter log) .......................................................................................................................................... 27

Tabela 3-23 Disable log (desativar log) ............................................................................................................................. 27

Tabela 4-1 Set graph (definir gráfico) ................................................................................................................................ 29

Tabela 4-2 Append graph (anexar gráfico) ........................................................................................................................ 34

Tabela 4-3 View graph (exibir gráfico) ............................................................................................................................... 35

Tabela 4-4 Clear graph (limpar gráfico) ............................................................................................................................. 36

Tabela 4-5 Modify node (modificar nó) .............................................................................................................................. 37

Tabela 4-6 Delete node (excluir nó) ................................................................................................................................... 38

Tabela 5-1 E-mail de notificação ....................................................................................................................................... 42

Tabela 6-1 Códigos de erro da API ..................................................................................................................................... 44

Lista de figuras

Figura 3-1 Put job, exemplo de solicitação de carga ........................................................................................................... 7

Figura 3-2 View job, exemplo de resposta bem-sucedida ................................................................................................ 11

Figura 3-3 Delete job, exemplo de resposta bem-sucedida .............................................................................................. 12

Figura 3-4 Get files, exemplo de resposta (aplicável apenas para formato=links) .......................................................... 13

Figura 3-5 Set purge settings, exemplo de solicitação de carga ...................................................................................... 14

Figura 3-6 Set purge settings, exemplo de resposta bem-sucedida ................................................................................ 14

Figura 3-7 Get device info, exemplo de resposta bem-sucedida ...................................................................................... 15

Figura 3-8 Get device status, exemplo de resposta .......................................................................................................... 16

Figura 3-9 Get solution info, exemplo de resposta ........................................................................................................... 17

Figura 3-10 Get solution status, exemplo de resposta ..................................................................................................... 18

Figura 3-11 Wake up, exemplo de resposta bem-sucedida .............................................................................................. 19

Figura 3-12 Cancel scan, exemplo de resposta bem-sucedida ......................................................................................... 20

Figura 3-13 Reset solution, exemplo de resposta bem-sucedida .................................................................................... 21

Figura 3-14 Extensibility services, Set button — exemplo de solicitação de carga ......................................................... 22

Figura 3-15 Extensibility services, Set button — exemplo de resposta bem-sucedida .................................................. 22

Figura 3-16 Remove button, exemplo de resposta bem-sucedida ................................................................................... 23

Figura 3-17 Set API password, exemplo de solicitação de carga ...................................................................................... 24

Figura 3-18 Set API password, exemplo de resposta bem-sucedida ................................................................................ 24

Figura 3-19 Block Embedded Capture UI, exemplo de resposta bem-sucedida ............................................................... 25

Figura 3-20 Unblock Embedded Capture UI, exemplo de resposta bem-sucedida .......................................................... 26

Figura 3-21 Enable log, exemplo de solicitação de carga ................................................................................................. 27

Figura 3-22 Enable log, exemplo de resposta bem-sucedida ........................................................................................... 27

Figura 3-23 Disable log, exemplo de resposta bem-sucedida .......................................................................................... 28

Figura 4-1 Set graph, exemplo de solicitação de carga ..................................................................................................... 30

Figura 4-2 Exemplo de resposta bem-sucedida ................................................................................................................ 34

Figura 4-3 Append graph, exemplo de resposta bem-sucedida ....................................................................................... 35

Figura 4-4 View graph, exemplo de resposta bem-sucedida ............................................................................................ 36

Figura 4-5 Clear graph, exemplo de resposta .................................................................................................................... 37

Figura 4-6 Modify node, exemplo de solicitação de carga ................................................................................................ 38

Figura 4-7 Modify node, exemplo de resposta .................................................................................................................. 38

Figura 4-8 Delete node, exemplo de resposta ................................................................................................................... 39

1 Introdução à API

A Interface de Programação de Aplicativo (API) do HP Embedded Capture (HP EC) permite a integração de

aplicativos cliente que interagem com dispositivos MFP para gerenciamento de fluxo de trabalho e captura

remota de documentos. Os serviços de API são fornecidos como parte do contrato de serviços profissionais

para o HP Embedded Capture 1.1 ou versões mais recentes.

1.1 Modos básico e avançado

A solução Embedded Capture opera com um conjunto de dispositivos MFP FutureSmart e não FutureSmart

MFP. O FutureSmart oferece um conjunto avançado de funcionalidades para que você aproveite todo o poder

do Embedded Capture. Os dispositivos não FutureSmart cobrem um subconjunto dessas funcionalidades

(básicas) com recursos padrão de captura de documentos como digitalização, metadados (com restrições) e

certos níveis de navegação (2) que cobrem a maioria dos casos de uso.

A API é dividida em duas categorias: básica e avançada.

1.1.1 API básica

A API básica é compatível com todo o conjunto de equipamentos (dispositivos FutureSmart e não

FutureSmart). Os integradores de API não precisam fazer distinção entre os modelos de dispositivos. As

mesmas chamadas de API e os mesmos URLs estão disponíveis para os dois modelos.

1.1.2 API avançada

A API avançada estende a complexidade e a flexibilidade de fluxos de trabalho gerenciados em um

dispositivo, oferecendo funcionalidades extra somadas às que a API básica oferece.

1.2 Acessando a API em um dispositivo (%API_URL%)

A API do Embedded Capture é exposta ao MFP em URLs específicos através do uso de SSL (recomendado).

Embora não seja possível usar a API em modo http sem criptografia, isso NÃO é recomendado. A implantação

de fluxos de trabalho com parâmetros associados (incluindo senhas) será transferida em texto puro pela

rede, e pode estar exposta a acesso não autorizado.

Seção 1.1 Modos básico e avançado 1

Algumas chamadas de API enviam parâmetros por GET; outras, por POST. Isso é especificado em cada tabela

de definição da API.

NOTA: As mudanças no protocolo de transporte (para usar ou parar de usar SSL) devem ser realizadas

durante a configuração dos dispositivos (servidor Web incorporado). Consulte o Guia do administrador do HP

Embedded Capture para obter mais informações.

NOTA: Para todos os métodos de API descritos neste documento, os URLs foram simplificados através da

substituição do valor por %API_URL%

1.2.1 Codificação XML

Todos os parâmetros da API se baseiam em documentos XML padrão. As convenções usadas para esse XML

são as seguintes:

●

Grafia PascalCase para elementos

●

Grafia camelCase para atributos

Exemplo:

1.2.2 Validação de XSD

A API do Embedded Capture é validada por um esquema XSD disponível para download a partir dos

dispositivos. Cada API inclui uma seção de “esquema” que ajuda na obtenção do documento XSD em tempo

real.

Para que eventuais problemas com o conteúdo de um PC cliente sejam identificados, é altamente

recomendável que os esquemas XSD sejam usados para validar o conteúdo antes que ele seja enviado para a

API.

1.2.3 Códigos de resposta

Para cada chamada de API, exceto o método "get" das APIs de "registro em log", a mensagem de resposta

terá um código e uma mensagem descritiva. A descrição da mensagem pode mudar em versões futuras do HP

Embedded Capture (HP EC).

DICA: Qualquer aplicativo cliente que use as informações da resposta pode usar os códigos de erro em vez

das sequências de caracteres para garantir a compatibilidade futura.

2 Capítulo 1 Introdução à API

2 Segurança de API

Para evitar o acesso não autorizado, todas as chamadas de API podem ser protegidas por senha pelo

administrador. A proteção da API garante que o MFP não possa ser acessado por qualquer PC ou aplicativo

cliente que desconheça as credenciais para a execução das chamadas de API.

NOTA: É altamente recomendável proteger a API definindo a senha de controle de acesso.

2.1 Contas de administrador e API

2.1.1 Conta de administrador

A conta de administrador corresponde às credenciais da conta de administrador (admin) do dispositivo. Um

dispositivo MFP precisa ser protegido com uma senha de administrador para que as opções avançadas,

configurações de rede etc. (servidor da Web incorporado) possam ser acessadas.

O administrador conclui as seguintes operações durante a instalação e a configuração normal do Embedded

Capture:

●

setButton

●

removeButton

●

setApiPassword

●

put (silent mode)

●

resetSolution

Porém, é recomendável o uso de uma senha diferente para as chamadas de API padrão. Isso é explicado nas

próximas seções.

2.1.1.1 Conta de usuário “apiuser”

Definir essa conta é opcional, mas é altamente recomendável. Caso configurada, ela será necessária para

todas as operações de API, exceto pelas especificadas acima (setButton, removeButton, setApiPassword, put

(silent mode), resetSolution).

2.1.2 Usando a API sem autenticação

Se a autenticação não for usada na API, certas operações ainda exigirão que uma senha de administrador seja

definida. Isso se deve às seguintes restrições no uso de dispositivos padrão:

●

setButton, removeButton, resetSolution:

Usuário e senha de administrador são necessários para a execução dessas chamadas. Quando a solução

é instalada a partir do console de administrador, um botão padrão é criado, e a senha já é usada de

maneira transparente para o administrador (especificado na lista de dispositivos).

●

putSilent:

Usuário e senha de administrador são necessários para a execução dessa chamada. Após a instalação

da solução, o HP Embedded Capture memoriza a senha do administrador. Isso evita a necessidade de

especificar uma senha nas chamadas "put (silent mode)" da API. Se a senha de administrador do

Seção 2.1 Contas de administrador e API 3

dispositivo for alterada, a senha “em cache” do Embedded Capture precisa ser atualizada através de

UMA destas duas opções:

◦

Execute qualquer chamada de API com autenticação básica usando usuário e senha do

administrador.

◦

A partir do console de administrador, edite a senha de administrador em todos os dispositivos

alterados e pressione o botão Remove workflow (remover fluxo de trabalho).

2.2 Autenticação de acesso básico

O Embedded Capture usa autenticação de acesso básico para qualquer operação de API que exija

autenticação. Para que as credenciais sejam transmitidas por HTTP, essa autenticação precisa ser usada.

Para obter informações detalhadas sobre a autenticação de acesso básico, consulte: http://en.wikipedia.org/

wiki/Basic_access_authentication

Para fazer login com as credenciais de usuário da API, o nome de usuário precisa ser “apiuser” e a senha

precisa ser a especificada através da operação SetApiPassword.

4 Capítulo 2 Segurança de API

3 API compatível

3.1 Serviços de gráficos e trabalhos

3.1.1 Put job (carregar trabalho)

Tabela 3-1 Put job (carregar trabalho)

?api=jobs&method=put

POST Descrição Carrega um novo trabalho de digitalização (fluxo de trabalho simples) para o MFP de destino. Carregar

um trabalho de digitalização em modo compatível anexa o trabalho aos fluxos de trabalho existentes

no dispositivo. Carregar um trabalho de digitalização com os mesmos parâmetros de filtragem de

outro existente faz com que dois trabalhos com as mesmas opções de menu sejam exibidos no painel

de controle.

Autenticação Autenticação básica de "admin" ou "apiuser" exigida para operação "put" de trabalhos silenciosos.

Para outros, é opcional.

Carga ENTRA

XML: detalhes do trabalho. Contém:

Configurações de navegação (opcional (*))

Configurações de digitalização

Opções personalizadas

Opções de metadados

Notificação

Destino

(*) Trabalho silencioso: se o elemento de configurações de navegação não for definido, o

trabalho é considerado silencioso. Trabalho silencioso é o fluxo de trabalho de digitalização

e envio executado imediatamente após a conclusão da operação de put; nenhuma interação

com o usuário é possível no painel de controle do dispositivo. Esse é um exemplo de uso

típico do driver TWAIN.

SAÍDA Se 200, resposta de XML com identificador de trabalho.

Se 400, resposta de XML com código de erro.

Código

resposta

200 OK — sucesso

400 Solicitação incorreta

Código de erro -1: produto não licenciado

Código de erro -3: erro na análise da carga de XML

Código de erro -10: dispositivo ocupado (modo silencioso)

Código de erro -11: Tamanho de mídia sem suporte

Código de erro -12: erro inesperado

401 Acesso não autorizado — caso a autenticação básica falhe

411 Tamanho exigido — se o tamanho do conteúdo não for especificado ou for especificado

incorretamente

Seção 3.1 Serviços de gráficos e trabalhos 5

Tabela 3-1 Put job (carregar trabalho) (continuação)

500 Erro interno do servidor — se houver muitas solicitações ativas. Recomenda-se uma nova

tentativa.

Esquema Solicitação

?api=jobs&schema=put

Resposta

?api=jobs&rschema=put

6 Capítulo 3 API compatível

Figura 3-1 Put job, exemplo de solicitação de carga

Exemplos de destino

É possível atribuir os seguintes destinos a um trabalho de digitalização:

Seção 3.1 Serviços de gráficos e trabalhos 7

●

Local

O destino Local salva documentos digitalizados no disco rígido do dispositivo. Eles não são enviados

para fora do dispositivo, e só podem ser recuperados através de uma operação get da API.

●

E-mail

●

FTP

●

Pasta de rede

●

Exemplo de resposta bem-sucedida:

8 Capítulo 3 API compatível

●

Exemplo de resposta com erro:

Por exemplo, quando dois trabalhos com os mesmos filtros de navegação “label A” e “label B” são

carregados, ambos estarão visíveis em “label A”.

Label A: AAC

Label B: FULL EMAIL JOB

NOTA: Consulte o APÊNDICE I para conhecer possíveis configurações e valores padrão.

3.1.2 View job (exibir trabalho)

Tabela

3-2 View job (exibir trabalho)

?api=jobs&method=view&jobId={jobId}

GET Descrição Recupera os detalhes do trabalho na forma como foram configurados na chamada put da

API.

Se a ID for definida como 0, retorna os detalhes de todos os trabalhos de fluxo de

trabalho.

Seção 3.1 Serviços de gráficos e trabalhos 9

Tabela 3-2 View job (exibir trabalho) (continuação)

Se a ID não for 0, retorna os detalhes do trabalho correspondente à id especificada.

Carga ENTRADA -

SAÍDA Se 200, resposta de XML com detalhes de trabalho.

Se 400, resposta de XML com código de erro.

Código de resposta 200 OK — sucesso

400 Solicitação incorreta:

Código de erro -2: id de trabalho inválida.

Código de erro -5: a id não corresponde a um trabalho.

401 Acesso não autorizado — caso a autenticação básica falhe.

500 Erro interno do servidor — se houver muitas solicitações ativas. Recomenda-se uma

nova tentativa.

Esquema Solicitação -

Resposta

?api=jobs&rschema=view

10 Capítulo 3 API compatível

Figura 3-2 View job, exemplo de resposta bem-sucedida

3.1.3 Delete job (excluir trabalho)

Tabela

3-3 Delete job (excluir trabalho)

?api=jobs&method=delete&jobId={jobId}

Seção 3.1 Serviços de gráficos e trabalhos 11

Tabela 3-3 Delete job (excluir trabalho) (continuação)

GET Descrição Remove um trabalho alterando seu status para “cancelled” (cancelado). Os trabalhos

excluídos ainda aparecerão em uma solicitação de visualização da API, porém com status

cancelado até que eles sejam limpos pelo coletor de lixo do Embedded Capture.

Se jobId for definido como 0, todos os trabalhos do gráfico serão removidos.

Se jobId não for zero, apenas o trabalho especificado será removido.

Carga ENTRADA —

SAÍDA Se 200, resposta de XML com código 0.

Se 400, resposta de XML com código de erro.

Código de resposta 200 OK – sucesso

400 Solicitação incorreta:

Código de erro -2: id de trabalho inválida.

Código de erro -5: a id não corresponde a um trabalho.

Código de erro -12: erro de operação.

401 Acesso não autorizado – caso a autenticação básica falhe.

500 Erro interno do servidor – se houver muitas solicitações ativas. Recomenda-se uma nova

tentativa.

Esquema Solicitação —

Resposta

?api=common=default

Figura 3-3 Delete job, exemplo de resposta bem-sucedida

3.1.4 Get files (obter arquivos)

Tabela

3-4 Get files (obter arquivos)

?api=jobs&method=getFiles&jobId={jobId}&format}={format}

GET Descrição Recupera os arquivos digitalizados pelo trabalho correspondente à id especificada.

Se o formato for definido como “zip”, retorna todos os arquivos em um zip.

Se o formato for definido como “boundary”, retorna todos os arquivos como uma mensagem

MIME de várias partes (http://en.wikipedia.org/wiki/MIME).

Se o formato for definido como “links”, retorna um xml com links diretos para o download de

arquivos.

12 Capítulo 3 API compatível

Tabela 3-4 Get files (obter arquivos) (continuação)

Para trabalhos silenciosos (sem interação do usuário no painel de controle), a operação getFiles é

uma operação de bloqueio (ou seja, nenhum resultado é retornado até que os arquivos estejam

prontos ou o trabalho seja cancelado).

Não obtém arquivos de metadados ao obter arquivos a partir de uma chamada de API após o

carregamento de um trabalho local com metadados com valor true (verdadeiro).

Carga ENTRADA —

SAÍDA Se 200, resposta de XML com arquivos ou xml com links para download

direto.

Se 400, resposta de XML com código de erro.

Código de

resposta

200 OK – sucesso

400 Solicitação incorreta:

Código de erro -2: id de trabalho inválida

Código de erro -5: a id não corresponde a um trabalho

Código de erro -6: erro ao carregar informações de trabalho

Código de erro -7: erro ao criar zip

401 Acesso não autorizado – caso a autenticação básica falhe

500 Erro interno do servidor – se houver muitas solicitações ativas. Recomenda-se uma nova

tentativa.

Esquema Solicitação —

Resposta

?api=jobs&rschema=getFiles

Figura 3-4 Get files, exemplo de resposta (aplicável apenas para formato=links)

3.1.5 Set purge settings (definir configurações de limpeza)

Tabela

3-5 Set purge settings (definir configurações de limpeza)

?api=jobs&method=setPurgeSettings

Seção 3.1 Serviços de gráficos e trabalhos 13

Tabela 3-5 Set purge settings (definir configurações de limpeza) (continuação)

POST Descrição Define o tempo de expiração e o período de coleta de lixo para trabalhos de digitalização

dinâmicos no MFP. Essas variáveis controlam por quanto tempo um trabalho permanece no

dispositivo.

Expiration time (tempo de expiração) corresponde à quantidade de tempo pela qual trabalhos

dinâmicos permanecem no dispositivo.

Collector period (período do coletor) corresponde ao intervalo entre operações subsequentes

de limpeza de trabalhos expirados. O período do coletor não pode ser maior que o tempo de

expiração. Os dois valores são definidos em segundos.

Por padrão, o período do coletor é definido como 30 minutos e o tempo de expiração como 12

horas. O intervalo válido para o período do coletor está entre 1800 s (30 minutos) e 86400 s (24

horas). O tempo de expiração não é restrito.

Carga ENTRADA Parâmetros de configuração do XML

SAÍDA Se 200, resposta de XML com código 0

Se 400, resposta de XML com código de erro

Código de

resposta

200 OK – sucesso

400 Solicitação incorreta:

Código de erro -3: erro na análise da carga de xml

401 Acesso não autorizado – caso a autenticação básica falhe

411 Tamanho exigido – se o tamanho do conteúdo não for especificado ou for especificado

incorretamente

500 Erro interno do servidor – se houver muitas solicitações ativas. Recomenda-se uma nova

tentativa.

Esquema Solicitação

?api=jobs&schema=setPurgeSettings

Resposta

?api=common&rschema=default

Figura 3-5 Set purge settings, exemplo de solicitação de carga

Figura 3-6 Set purge settings, exemplo de resposta bem-sucedida

14 Capítulo 3 API compatível

A página está carregando...

HP Embedded Capture Device License 500 Plus E-LTU Guia de referência

Marca: HP

Modelo: Embedded Capture Device License 500 Plus E-LTU

Tipo: Guia de referência

Este manual também é adequado para

Baixar PDF

relatório

HP Embedded Capture Device License 500 Plus E-LTU Guia de referência

Este manual também é adequado para

HP Embedded Capture Device License 500 Plus E-LTU Guia de referência

Outros documentos