Linha Datasul

Árvore de páginas


 O serviço TOTVS Datasul 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 é hospedado para o contexto do TOTVS-REST, com seu acesso pela URL http(s)://<host>:<port>/totvs-rest/public/ws/WebServiceExecBO.
    • Com a finalidade de manter a compatibilidade com as integrações já existentes, foi implementado um serviço para a URL http(s)://<host>:<port>/wsexecbo/WebServiceExecBO?wsdl, que redireciona para o contexto anterior.
  • A descrição WSDL do serviço podem ser acessada por meio das URLs:
    • http(s)://<host>:<port>/totvs-rest/public/ws/WebServiceExecBO.wsdl 
    • http(s)://<host>:<port>/wsexecbo/WebServiceExecBO?wsdl

As operações disponíveis neste serviço são:

OperaçãoDescrição
login

Recebe 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.

    • Suportado somente para usuários internos.


Recomendamos a utilização do serviço api/auth/accesstoken, para geração de token para usuários internos e externos.

userAndPasswordLogin

Recebe como argumentos o nome do usuário ("arg0"), senha ("arg1") e retorna um TOKEN JWT.

    • Suportado somente para usuários internos.


Recomendamos a utilização do serviço api/auth/accesstoken, para geração de token para usuários internos e externos.

logoutSession

Depreciado. 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").
callProcedureWithTokenAndCompany

Recebe 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").

Aviso

Verificar a configuração em Propriedades → Propriedades Gerais → WebService (Permite login WebService).

  • Caso esta propriedade não exista no banco de dados, o sistema permitirá o acesso as operações de login (login, userLogin e userAndPasswordLogin). Se houver algum valor incorreto no atributo, ocorrerá o bloqueio as operações de WebService login.

Recomendamos a utilização do serviço responsável pela geração de Token JWT de acordo com as credencias do usuário  (http://[SERVIDOR]:[PORTA]/api/auth/accesstoken)

A nível de teste pode-se utilizar a ferramenta SOAPUI ou Postman. Neste caso foi utilizado o SOAPUI 5.5.0.

Supondo que a ferramenta esteja instalada, pode-se seguir as etapas abaixo para validação e testes:


1- Clicar no botão "Explorer EndPoint" e informar a URL onde se encontra o serviço.

Caso a URL esteja funcional, será retornado o arquivo com as informações do WSDL (É a mesma situação que ocorre em execuções direta da URL pelo navegador):


2- Criar um projeto:


3- Adicionar a URL WSDL (Project → Add WSDL) → informar a URL onde se encontra a descrição WSDL do serviço):



Com isto, são carregados uma coleção com os endpoints/operações deste serviço, as quais já estão informadas no quadro acima, sendo disponíveis para utilização.


4- Efetuar uma requisição de "login".

Neste exemplo foi realizada a requisição REST ao endpoint api/auth/accesstoken para geração do TOKEN JWT.


5- Com base no token JWT gerado, efetuar a chamada aos programas Progress com o endpoint/operador desejado.

Neste exemplo foi utilizado o callProcedureWithToken.


O exemplo acima utiliza o programa Progress "CalculadoraSimples.p", abaixo está o trecho de código para testes.

java/CalculadoraSimples.p
        <!--Optional:-->
		<arg1>java/CalculadoraSimples.p</arg1>
	    <!--Optional:-->
	    <arg2>pi-calc</arg2>
         <!--Optional:-->
         <arg3>[ { "name":"pOperador", "type":"input", "dataType":"character", "value":"+"},
				{ "name":"pNum1", "type":"input", "dataType":"decimal", "value":1},
				{ "name":"pNum2", "type":"input", "dataType":"decimal", "value":1},
				{ "name":"pResult", "type":"output", "dataType":"decimal", "value":0 } ]
	    </arg3>