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 num bloco será necessário, primeiramente, criar um bloco do tipo servidor(Só é possível ativar essa funcionalidade em blocos servidor) . Caso haja alguma dúvida em relação a como criar um bloco do tipo servidor clique aqui. Nesse exemplo, utilizaremos um bloco para retornar o resultado de uma soma entre 2 números.
Figura 2 - Opção de configurar bloco(servidor)
Após criar o bloco servidor, clique no ícone indicado(figura 2) para abrir as configurações do bloco.
Figura 2.1 - Configurações do bloco(servidor)
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. Para confirmar se o bloco foi disponibilizado como SOAP, 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.2).
Figura 2.2 - Bloco gerado disponível na lista de serviços
Figura 2.3 - Xml do bloco(servidor)
Opções de segurança
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.
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). Para aprender mais sobre o consumo de webservices soap dentro do cronapp, clique aqui.