Uso de Serviços da Web
Preparando o RICOH ProcessDirector para receber solicitações de serviços Web
Antes que você possa enviar solicitações de serviços Web, você precisa criar um usuário e senha do RICOH ProcessDirector para os serviços web que serão usados. Certifique-se de que o ID de usuário tenha o nível apropriado de autoridade no RICOH ProcessDirector para realizar as ações fornecidas no serviço web. Para os exemplos neste capítulo, a autoridade do Operador é suficiente. Se você estiver utilizando o LDAP para autenticação, crie um usuário no LDAP para usar os serviços web. O usuário LDAP deve pertencer a um grupo que tenha o nível apropriado de autoridade no RICOH ProcessDirector.
Como todos os usuários precisam alterar suas senhas na primeira vez que fazem login, faça login na interface com o usuário do RICOH ProcessDirector usando o ID de usuário que você acaba de criar e altere a senha. Se você tiver senhas definidas para expirar após um determinado período de tempo, você precisa fazer login e alterar essa senha conforme necessário.
Preparando solicitações para o serviço web
Ao criar as solicitações, tenha em mente os seguintes pontos:
- O usuário dos serviços web precisa fazer login antes de realizar qualquer ação.
Para enviar quaisquer solicitações de serviço web, primeiro é necessário usar o serviço web GET/users/login para efetuar login no RICOH ProcessDirector como o usuário do serviço web e receber um token de credenciais. Esse token deve ser incluído no cabeçalho de todas as solicitações de serviço web enviadas até você enviar o serviço web POST /users/logout/{name}.
- Nomes de propriedade devem ser expressos no formato do banco de dados, e não no formato
do interface do usuário.
Ao incluir o nome da propriedade em uma solicitação, você precisa utilizar o nome da propriedade no banco de dados. Por exemplo, se você deseja usar GET /objects/{objectType} para recuperar o valor Class de uma tarefa, insira Job.Class como o valor attribute na solicitação. Os nomes de propriedade do banco de dados estão disponíveis no campo de ajuda para cada propriedade, no sistema de ajuda do produto, nos resultados recebidos de alguns dos serviços web e no Nomes de Propriedades do Banco de Dados.
- Valores de propriedade devem ser expressos no formato do banco de dados, e não no
formato do interface do usuário.
Ao incluir um valor em uma consulta, você deve certificar-se de que o valor é valido. Normalmente, campos numéricos exigem valores numéricos e campos de texto exigem valores de texto. Entretanto, algumas propriedades têm listas limitadas de valores.
Qualquer propriedade que forneça uma lista suspensa só pode aceitar certos valores. Além disso, os valores que aparecem nessas listas nem sempre são os mesmos valores que estão armazenados no banco de dados. Por exemplo, no interface com o usuário, os valores para a propriedade Staple incluem:
- 2 a esquerda
- 2 a direita
- Esquerda superior
- Vertical esquerda superior
- Esquerda inferior
- 2_at_left
- 2_at_right
- Top_left
- Top_left_vertical
- Bottom_left
Nas solicitações de serviço web, você precisa utilizar o valor do banco de dados. Os valores do banco de dados para propriedades disponíveis estão disponíveis no sistema de ajuda do produto e no Nomes de Propriedades do Banco de Dados.
-
As propriedades posicionais da tarefa devem incluir os nomes de fase, etapa e fluxo de trabalho nessa ordem, após o nome da propriedade. Coloque cada um dos três nomes entre colchetes.
Esta cadeia JSON de exemplo especifica um arquivo de controle em um sistema Linux como o valor da propriedade da tarefa Identificar arquivo de controle do PDF (nome do banco de dados Job.IdentifyPDFControlFile):
"Job.IdentifyPDFControlFile[Prepare][IdentifyPDFDocuments][PullPDFSample]":"/aiw/aiw1/testfiles/PullPDF.ctl"
A propriedade da tarefa está na etapa IdentifyPDFDocuments na fase Preparar do fluxo de trabalho PullPDFSample.