Pular para o conteúdo principal

WebServices

WebServices disponíveis no BrERP​

O BrERP disponibiliza maneiras de acessar alguns dados através do WebService

São disponibilizadas através dos protocolos:

  • SOAP
  • RESTful

O protocolo SOAP é disponibilizado em duas versões:

  • CompositeService
  • ModelADService

ModelADService é nada mais que uma requisição de algum serviço especifico, seja a criação de um Parceiro de Negócios, Criação de Imagens, Busca por um determinado Documento, Ação de Documento ou até mesmo a Execução de um processo.

Os processos disponíveis estão listados abaixo

  • ModelADService
    • pancreatectômica
    • setDocAction
    • createData
    • deleteData
    • readData
    • getList
    • runProcess
    • updateData
    • queryData

CompositeService é a junção de um ou mais ModelADService, provavelmente será o mais utilizado por sua aplicação, já que engloba todos os processos anteriores em apenas uma requisição.

  • CompositeService
    • compositeOperation

Já o protocolo REST é disponibilizado em apenas um:

Exemplos de utilização do SOAP​

A dev&Co. Disponibiliza alguns exemplos de como utilizar os WebServices SOAP em seu Github em linguagens como:

Configuração de um WebService​

Model Oriented Web Service​

Para qualquer uma das Requisições SOAP que deseja fazer, é necessário iniciar a configuração por um Serviço do tipo Model Oriented Web Service, pois esse será responsável pela busca ou inserção dos dados.

ConfigBrERP1

  1. Escolha um Nome e uma Chave de Busca que facilite a sua busca pela Requisição.
  2. O Tipo do Serviço
  3. Tipo da requisição (Opções disponíveis na Tabela).
  4. Qual tabela será utilizada na requisição
  5. Os campos que serão enviados por sua aplicação através do WebService.
  6. Os campos que serão retornados para sua aplicação.
  7. Perfis terão acesso a requisição.

Composite Interface​

A requisição do tipo Composite entende e encaminha inúmeros comandos do tipo "Model", em outras palavras, ao usar esse tipo de requisição, você deve empacotar todas as requisições Model que desejar e enviá-las todas de uma vez.

ConfigBrERP2

A configuração do Composite é uma pouco mais simples, já que será a porta de entrada para as demais configurações:

  1. Nome e Chave de busca
  2. Tipo do serviço, que nesse caso será CompositeInterface
  3. Método, o qual será CompositeInterface_composite
  4. Será necessário informar quem terá acesso ao WebService