O SOAP (Simple Object Access Protocol) é um protocolo utilizado em trocas de informação entre sistemas, ou seja um formato padronizado para o envio de estruturas entre diferentes serviços. Esse padrão permite a comunicação entre plataformas totalmente diferentes, como por exemplo, C++, Java e Ruby sem muito trabalho. No Cronapp é possível utilizar esse serviço de forma low-code nos blocos de programação fazendo com que o bloco criado possa ser utilizado em outra aplicação de forma simples, além de agilizar ainda mais o desenvolvimento dos projetos.
Pré-requisitos
Antes de começar é necessário ter certeza de que se possui um ambiente preparado para a realização do exemplo. Abaixo estão os principais requisitos necessários.
Requisitos:
- Projeto do tipo web ou web-mobile criado. Caso haja dúvidas em relação a como criar esse tipo de projeto acesse o link (Criar novo projeto).
Visão Geral
Aqui veremos como ativar o serviço de SOAP nos blocos de programação, dessa forma disponibilizando o bloco para que possa ser utilizado em outra aplicação. No fim desse tutorial, será possível utilizar o bloco criado em outra aplicação Cronapp e exibir o resultado retornado pelo bloco.
Figura 1 - Bloco(servidor) utilizado no exemplo
Passos
Ativando SOAP no bloco de programação
Para ativar esse serviço em um bloco será necessário, primeiramente, criar um bloco do tipo servidor, só é possível ativar essa funcionalidade em blocos de programação do tipo servidor. Caso haja alguma dúvida em relação a como criar um bloco de programação, clique aqui.
Nesse exemplo, utilizaremos um bloco de programação para retornar a adição de 2 números via SOAP. Após desenvolver o bloco de programação, abra a janela de propriedades do Bloco de programação e ative a opção Disponibilizar como SOAP (item 1 da Figura 2.1) para gerar o Endereço SOAP (2).
Figura 2.1 - Opção de configurar bloco(servidor)
Ativando permissão de acesso
Assim como um WebService REST, as permissões de segurança afetam diretamente o serviço. Um WebService SOAP é trafegado via POST, logo a permissão "Permite Inserir" é a que deve ser usada para ele.
Nessa etapa, devemos marcar a opção "Disponibilizar como SOAP" para que nosso bloco possa ser disponibilizado como um web services. O campo "Endereço SOAP" exibe o local em que o web service do bloco estará disponível ao ser gerado. Após habilitar a opção clique em "Salvar" e posteriormente salve o bloco para confirmar as alterações.
Figura 2.2 - Acessando as permissões de segurança
Agora é necessário adicionar uma permissão para acessar a lista dos serviços SOAP disponíveis e para acessar a URL necessária para consumir o web service em outra aplicação, essa URL é chamada de WSDL. Para isso vá em projeto e selecione a opção "Permissão de segurança".
Figura 2.3 - Permissões de segurança
Nesse passo vamos adicionar a lista dos serviços soap como público para que possamos acessar a lista e obter o WSDL referente ao nosso bloco. Na aba Permissionáveis clique no editar referente a opção Public para abrir a janela contendo a lista das URL's que não possuem restrição de acesso, após isso vá até a aba visões clique no botão "Novo" para adicionar a lista de services como público.
Figura 2.4 - Permissões de segurança
Aqui, no passo 1 vamos digitar /services/** que é a url que contém a lista dos web services soap disponíveis na aplicação. Abaixo é possível escolher o tipo de permissão que gostaríamos de dar ao usuário que acessa essa página, em nosso caso não vamos alterar nada, entretanto caso não queira alguma dessas permissões basta desmarca-la e em seguida clicar em "Salvar" correspondente a página atual e as páginas anteriores. Para confirmar se o bloco foi disponibilizado como SOAP, rode o projeto e acesse o link https://<url da aplicação>/services/ para abrir a lista dos serviços SOAP disponíveis em sua aplicação(figura 2.5).
Figura 2.5 - Bloco gerado disponível na lista de serviços
Figura 2.6 - Xml do bloco(servidor)
Opções de segurança
Figura 3 - Configurações de segurança do bloco(servidor)
Acesse novamente as configurações do bloco (figura 2) e acesse os "..." referentes ao campo segurança. Em seguida, no passo 1, acesse os "..." referentes ao campo permitir inserir, essa propriedade define qual o tipo de permissão é usado para acessar o web service e após isso, no passo 2, selecione o tipo de permissão que se adéqua ao seu projeto. Autenticado permite que só usuários logados possam interagir com o serviço, administradores permite com que apenas usuários com perfil de administrador possam interagir com o serviço, todos permite com que qualquer usuário(inclusive os que não efetuaram o login) possa interagir com o serviço e nenhum faz com que nada consiga interagir com o serviço. Após isso, clique em "Ok" para confirmar o tipo de permissão(passo 2), depois clique em "Ok" para salvar a alteração das permissões da ação(passo 1), clique em "Salvar" para confirmar as configurações atuais e por fim salve o bloco.
Figura 3.2 - Bloco consumido em outra aplicação cronapp via SOAP
Aqui é possível verificar o bloco gerado nesse exemplo, disponível em outra aplicação cronapp por meio do serviço SOAP(Figura 3.2). Vale ressaltar que a categoria recebe o nome do bloco criado no projeto anterior e o bloco leva o nome da função desse mesmo bloco gerado no projeto anterior. Para aprender mais sobre o consumo de web services soap dentro do cronapp, clique aqui.