Histórico da Página
...
O serviço TOTVS Framework REST prove WEB-SERVICE prove um canal de comunicação entre a interface do usuário (front-end) e o servidor de aplicação / banco de dados (back-end). Tal serviço, permite o acesso a APIs , BOs ou a execução simples de programas (preparados para receber e enviar um JSon) via AppServer Progress.
| Informações Técnicas | |
|---|---|
| WAR Principal | totvs-fwk-rest.war |
| Objetivo | Permitir o acesso a execução de APIs, BOs ou programas preparados Progress, através de arquitetura REST (Representational State Transfer) através de um contexto seguro. |
| Entradas | Parâmetros via Query Parameters, Path Parameters, Payload (JSon) e Arquivo (Upload). |
| Saídas | Retornos via JSon e Arquivo (Download). |
| Métodos Suportados | GET, POST, PUT e DELETE |
Configuração
O TOTVS Framework REST necessita apenas como pré-requisito as configurações de conexão ao AppServer Progress e os programas Progress compilados (.r). Todo o gerenciamento de quais serviços, métodos, atributos estão disponíveis é feito pelo próprio TOTVS REST, não necessitando de nenhuma intervenção do desenvolvedor ou usuário.
| Nota | ||
|---|---|---|
| ||
Em comparação com o antigo Datasul REST, não existe mais a necessidade de geração dos arquivos JSon para cada arquivo Progress (API ou DBO). Da mesma forma, não são mais necessárias parametrizações nas propriedades indicando o caminho da listagem de serviços disponíveis (rest.properties). |
Compatibilidade de Navegadores
Os navegadores suportados pelo TOTVS Framework REST são:
...
via AppServer Progress. Este serviço substitui o antigo WS-EXEC-BO, mantendo as mesmas operações, porém destinado apenas a chamada de API´s.
Este serviço esta hospedo no mesmo contexto do TOTVS-REST, através da URL http(s)://<host>:<port>/totvs-rest/public/ws/WebServiceExecBO
...
| Informações | ||
|---|---|---|
| ||
Para garantir o funcionamento no Internet Explorer, é necessário desabilitar a opção "Incluir caminho do diretório local ao carregar arquivos em um servidor" em Opções da internet > Segurança > Nível personalizado... > Miscelânea. |
Utilização no desenvolvimento
O TOTVS Framework REST está preparado para efetuar chamadas de APIs, DBOs e execuções simples de programas Progress que estejam preparados para receber e retornar um JSon. Abaixo são apresentadas as formas de chamadas e tratamento para cada um dos tipos de execuções:
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas