Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

      O serviço TOTVS Framework WS-EXEC-BO prove um canal de comunicação (via WebServices) entre a interface do usuário (front-end) e o servidor de aplicação / banco de dados (back-end). Apesar do nome, este serviço deve ser utilizado apenas para chamadas à API´s, uma vez que as operações das DBO´s não são Stateless.

      Este serviço esta hospedado no mesmo contexto do TOTVS-REST, através da URL http(s)://<host>:<port>/totvs-rest/public/ws/WebServiceExecBO. Para manter a compatibilidade com as integrações já existentes foi implementado um outro serviço na URL http(s)://<host>:<port>/wsexecbo/WebServiceExecBO que apenas redireciona para o contexto anterior.

...

OperaçãoDescrição
loginRecebe como cabeçalhos HTTP o nome do usuário ("username") e a senha ("password") e retorna um TOKEN JWT que deve ser utilizado para as chamadas às outras operações.
userLoginRecebe como argumento ("arg0") o nome do usuário ou e-mail e retorna um TOKEN JWT.
userAndPasswordLoginRecebe como argumentos o nome do usuário ("arg0") e a senha ("arg1") e retorna um TOKEN JWT.
logoutSessionMantido apenas para compatibilidade, não é mais utilizado uma vez que o TOKEN JWT expira automaticamente.
callProcedureRecebe como cabeçalho HTTP o TOKEN JWT ("usertoken") e como argumentos o nome do programa ("arg0"), o nome do procedimento ("arg1") e os parâmetros desta ("arg2").
callProcedureWithCompanyRecebe como cabeçalho HTTP o TOKEN JWT ("usertoken") e como argumentos o código da companhia ("arg0"), nome do programa ("arg1"), o nome do procedimento ("arg2") e os parâmetros desta ("arg3").
callProcedureWithTokenRecebe como argumentos o TOKEN JWT ("arg0"), o nome do programa ("arg1"), o nome do procedimento ("arg2") e os parâmetros desta ("arg3").
callProcedureWithTokenAndCompanyRecebe como argumentos o TOKEN JWT ("arg0"), o código da companhia ("arg1"), o nome do programa ("arg2"), o nome do procedimento ("arg3") e os parâmetros desta ("arg4").

      O tempo de expiração do TOKEN JWT pode ser controlado pela propriedade "totvs.ws.auth.expiration", tendo como valor padrão "120" segundos.      O chave secreta de geração do TOKEN JWT é gerada randomicamente pelo serviço, porém, quando o ambiente possuí múltiplos Servidores de Aplicação WEB é necessário configurar manualmente a mesma por meio da propriedade "totvs.ws.secret".

Para maiores informações do JWT quanto a uso e configuração, verificar o link a seguir [DTS4THF] Configurando autenticação com JWT