Usando a documentação da REST API do RICOH ProcessDirector

O RICOH ProcessDirector fornece REST APIs para integração com o serviço da Web. A documentação interativa é disponibilizada com essas APIs e fornece testes e informações de cada API disponível.

A documentação da REST API inclui muitas APIs que um aplicativo pode utilizar para se integrar ao RICOH ProcessDirector. Você pode usar a documentação da REST API e a interface de testes para testar as configurações dos seus parâmetros. Ao usar a interface para testar serviços da Web, você pode acessar o servidor principal do RICOH ProcessDirector. Ações como criar, excluir e ativar objetos são executadas no servidor principal e são refletidas na interface do usuário do RICOH ProcessDirector. Como resultado, sugerimos criar objetos especificamente para fins de teste.

Estas etapas mostram como solicitar os arquivos de registro de um objeto usando REST APIs. Siga estas etapas para se conectar ao RICOH ProcessDirector, solicitar os arquivos de registro da impressora de exemplo e se desconectar.

  1. Abra um navegador da Web e digite seu nome de host do RICOH ProcessDirector ou endereço IP na barra de endereços. Adicione /restapi/ ao final do nome de host ou endereço IP para acessar a documentação da REST API. Por exemplo, http://hostname:15080/restapi/
  2. Na seção usuários, clique em Expandir operações e encontre GET /users/login.
  3. Faça login no RICOH ProcessDirector com suas credenciais do RICOH ProcessDirector:
    • Para o parâmetro nome, digite seu nome de usuário do RICOH ProcessDirector .
    • Para o parâmetro pwd, digite a senha associada ao seu nome de usuário do RICOH ProcessDirector.
  4. Clique no botão Experimente!
    A documentação da REST API usa os valores inseridos para criar um comando Curl e um URL de solicitação. Em seguida, ela envia a solicitação para o URL de solicitação e faz o login.

    O RICOH ProcessDirector envia uma resposta indicando se o login foi bem-sucedido. A resposta inclui informações adicionais, como o token e as ações que este ID de usuário tem permissão para realizar.

  5. Na caixa Corpo da resposta, localize e copiar o valor do token.

  6. Na seção objetos, clique em Expandir operações. Role para baixo até encontrar GET /objects/log/{objectType}/{name}.
  7. Para recuperar as mensagens de registro da impressora de amostra, use os seguintes parâmetros:
    1. Para o parâmetro token, cole o token que você copiou acima.
    2. Para o parâmetro objectType, digite Printer.
    3. Os valores de objectType diferenciam letras maiúsculas e minúsculas. Você pode usar o serviço da Web GET /util/objecttypes para obter uma lista de tipos de objeto disponíveis no seu sistema. Você pode encontrar o serviço da Web GET /util/objecttypes na seção util.
    4. Para o parâmetro nome, digite Sample.
  8. Clique no botão Experimente!
    As entradas de registro da impressora de amostra são retornadas na caixa Corpo da resposta.

    Os valores de Cul e URL de solicitação também são retornados.

  9. Na seção usuários, clique em Expandir operações e encontre POST/users/logout/{name}.
  10. Faça logout do RICOH ProcessDirector:
    • Para o parâmetro token, cole o token que você copiou acima.
    • Para o parâmetro nome, digite seu nome de usuário do RICOH ProcessDirector .
  11. Clique no botão Experimente!
    Você está desconectado do RICOH ProcessDirector.

  12. Algumas APIs incluem valores de exemplo. Com valores de exemplo, você pode copiar uma sequência de códigos de amostra para o campo de corpo e modificá-lo para teste.

    Estas etapas mostram como usar uma REST API para conectar um hot folder. Siga estas etapas para fazer login no RICOH ProcessDirector, configurar o Dispositivo de entrada para aceitar arquivos do HotFolderPDF e se desconectar.

  13. Abra um navegador da Web e digite seu nome de host do RICOH ProcessDirector ou endereço IP na barra de endereços. Adicione /restapi/ ao final do nome de host ou endereço IP para acessar a documentação da REST API. Por exemplo, http://hostname:15080/restapi/
  14. Na seção usuários, clique em Expandir operações e encontre GET /users/login.
  15. Faça login no RICOH ProcessDirector com suas credenciais do RICOH ProcessDirector:
    • Para o parâmetro nome, digite seu nome de usuário do RICOH ProcessDirector .
    • Para o parâmetro pwd, digite a senha associada ao seu nome de usuário do RICOH ProcessDirector.
  16. Clique no botão Experimente!
    A documentação da REST API usa os valores inseridos para criar um comando Curl e um URL de solicitação. Em seguida, ela envia a solicitação para o URL de solicitação e faz o login.

    O RICOH ProcessDirector envia uma resposta indicando se o login foi bem-sucedido. A resposta inclui informações adicionais, como o token e as ações que este ID de usuário tem permissão para realizar.

  17. Na caixa Corpo da resposta, localize e copiar o valor do token.
  18. Na seção objetos, clique em Expandir operações. Role para baixo até encontrar POST /objects/{objectType}/connect.
  19. Insira estes parâmetros para conectar o HotFolderPDF:
    1. Para o parâmetro token, cole o token que você copiou acima.
    2. Para o parâmetro objectType, digite InputDevice.
      Os valores de objectType diferenciam letras maiúsculas e minúsculas. Você pode usar o serviço da Web GET /util/objecttypes para obter uma lista de tipos de objeto disponíveis no seu sistema. Você pode encontrar o serviço da Web GET /util/objecttypes na seção util.
    3. Para o parâmetro de corpo, clique no valor de exemplo. O texto do valor de exemplo é copiado para o parâmetro de corpo. Substitua a palavra “string” por “HotFolderPDF”. Certifique-se de que há aspas duplas em volta do nome do objeto.
  20. Clique no botão Experimente!
    As propriedades e configurações de HotFolderPDF são retornadas na caixa Corpo da resposta. O código de resposta e os cabeçalhos de resposta também são retornados.
  21. Na seção usuários, clique em Expandir operações e encontre POST/users/logout/{name}.
  22. Faça logout do RICOH ProcessDirector:
    • Para o parâmetro token, cole o token que você copiou acima.
    • Para o parâmetro nome, digite seu nome de usuário do RICOH ProcessDirector .
  23. Clique no botão Experimente!
    Você está desconectado do RICOH ProcessDirector.

Related information:

Preparar para enviar tarefas usando serviços da Web
Preparar para enviar tarefas usando serviços da Web
Preparar para enviar tarefas usando serviços da Web
Tópico principal: Serviços da Web no RICOH ProcessDirector