Interface Webservice

Integração de aplicativos externos

Serviços web

O RSJ LPSNG fornece os seguintes serviços da web:

  • Envie o trabalho de impressão

Enviar trabalho de impressão

Parâmetro Valor
URL / submit
Método POST
Tipo de Conteúdo multipart / form-data
título Descrição do trabalho para exibição
formato ID do layout
dados Dados (em CSV, JSON, XML ou Excel)
callback retorno de chamada JSONP opcional
oauth_token Token de acesso do OAuth2 (se não especificado no cabeçalho HTTP de autorização no esquema OAuth)

Autenticação

O RSJ LPSNG usa o protocolo OAuth2 padrão para integrar com segurança vários aplicativos externos independentes a uma infinidade de usuários.

O RSJ LPSNG usa essa autenticação como base para suas decisões de roteamento

Registro de aplicativo externo

Os desenvolvedores podem registrar um aplicativo externo com o RSJ LPS NG on-line fornecendo:

  • Nome da Aplicação
  • Descrição da aplicação
  • Ícone da aplicação
  • URL de redirecionamento do aplicativo

Eles receberão:

  • ID do aplicativo
  • Segredo da Aplicação

Autorização de Aplicação Externa

Os usuários finais podem autorizar aplicativos externos online para usar o RSJ LPS NG em seu desempenho.

End User View

  1. O usuário clica em um link no aplicativo externo, que os redireciona para o logon RSJ LPSNG (se já não estiver conectado) e, em seguida, para a tela de autorização RSJ LPS NG
  2. Se o usuário aceitar a vinculação do aplicativo, ele será redirecionado novamente para o aplicativo externo em que as informações de autenticação estão armazenadas.

Visualização do aplicativo externo

O aplicativo externo fornece as seguintes informações com o redirecionamento:

  • ID do aplicativo (atribuído durante o registro do aplicativo)
  • URL de retorno de chamada (especificado durante o registro do aplicativo)
  • Informações de contexto opcionais (para retorno de chamada)
Parâmetro Valor
URL / autorizar
Método GET
client_id Id do cliente (do registro do aplicativo)
response_type código
âmbito cheio
redirecion_uri URI de redirecionamento (deve corresponder ao URI no registro do aplicativo)
estado Informações de contexto opcionais para retorno de chamada

Após a autorização bem-sucedida, a sessão do usuário final é redirecionada para o aplicativo externo com os seguintes parâmetros:

  • Informação de contexto (do redirecionamento)
  • Código de autorização temporário (válido por 10 minutos)

O aplicativo externo chama um serviço da Web para trocar a autorização temporária pelo token de atualização permanente, fornecendo:

  • Código de autorização temporária
  • ID do aplicativo
  • Segredo da Aplicação
  • URL de retorno

O aplicativo externo armazena permanentemente o token de atualização para o usuário final

Parâmetro Valor
URL / auth
Método POST
grant_type refresh_token
refresh_token Atualizar token (da autorização de aplicativo)
Retorna Estrutura JSON

Solicitações de aplicativos externos

O aplicativo externo deve trocar o token de atualização por um token de acesso válido temporariamente (60 minutos) antes de acessar o RSJ LPSNG para um usuário final. Ele chama um serviço da web com:

  • Atualizar token

Recebe:

  • Token de acesso temporário (60 minutos)

O aplicativo externo inclui esse token de acesso em suas solicitações de serviço da web (no cabeçalho HTTP de autenticação ou como um parâmetro)

O RSJ LPSNG associa o token de acesso ao aplicativo externo e ao usuário final.

O token de acesso pode se tornar inválido a qualquer momento (mesmo antes de expirar). Nesse caso, um erro 401 é retornado e o aplicativo externo deve recuperar um novo token de acesso antes de tentar novamente a solicitação com falha.

Parâmetro Valor
URL / auth
Método POST
grant_type authorization_code
código Código de autorização (do redirecionamento)
client_id Id do cliente (do registro do aplicativo)
client_secret Segredo do Cliente (do registro do aplicativo)
refresh_token Atualizar token (da autorização de aplicativo)
Retorna Estrutura JSON