APIs REST vs. APIs SOAP: Qual delas escolher?

Gabriel Cioci em 19 de maio de 2021

É comum comparar SOAP vs. REST, dois dos paradigmas de API mais comuns, quando se discutem arquitecturas de API. Embora os dois sejam frequentemente comparados como se fossem iguais, certamente não são. Porquê? Porque são duas tecnologias fundamentalmente diferentes que são difíceis de comparar a um nível granular.

O SOAP é um protocolo e o REST é um estilo arquitetónico. São embalados de forma diferente, têm caraterísticas diferentes e são utilizados em situações diferentes.

Agora que já esclarecemos esta questão, vamos analisar cada um deles mais detalhadamente, incluindo algumas das vantagens que o podem persuadir a escolher um em vez do outro para a sua aplicação.

Uma API (interface de programação de aplicações) é um acordo entre serviços Web que especifica a forma como irão partilhar dados, como a recuperação de um mapa ou as suas credenciais de início de sessão.

Os próprios dados são organizados em mensagens que os sistemas podem enviar uns aos outros.

Tipos de API

As APIs abertas, também conhecidas como APIs públicas, não têm limites sobre quem as pode utilizar, uma vez que são públicas.

As API de parceiros exigem que os programadores tenham privilégios ou licenças específicas para utilizar este tipo de API, uma vez que não estão acessíveis ao público em geral.

As APIs internas, também conhecidas como APIs privadas, são criadas para uso interno numa organização. As equipas internas da empresa utilizam esta forma de API para desenvolver os seus bens e serviços.

As APIs compostas são úteis em arquitecturas de microsserviços, em que um utilizador pode necessitar de dados de vários serviços para concluir uma única tarefa. Uma vez que uma única chamada pode devolver todos os dados de que um utilizador necessita, as API compostas podem minimizar a carga do servidor e aumentar o desempenho da aplicação.

Casos de utilização da API

As APIs estão em todo o lado, alimentando as nossas vidas nos bastidores, mesmo que não nos apercebamos disso. Compilámos uma lista de cinco dos exemplos mais relevantes de utilização de API no nosso quotidiano para o ajudar a compreender melhor o que são as API e como funcionam.

Provavelmente já viu estas integrações de API em todo o lado, desde o início de sessão com o Facebook até ao pagamento com o PayPal.

1. Iniciar sessão utilizando XYZ

Um exemplo típico de utilização da API é a funcionalidade "iniciar sessão utilizando o Facebook/Twitter/Google" que se encontra em muitos sítios Web. É vantajoso, mas já pensou como é que funciona?

Em vez de iniciarem explicitamente uma sessão nas contas das redes sociais dos utilizadores (o que constituiria um risco de segurança significativo), estes sítios Web utilizam as API destas plataformas para autenticar o utilizador em cada início de sessão.

2. Fragmentos meteorológicos

Os dados meteorológicos são outro caso de utilização de API popular que vemos todos os dias.

Os snippets meteorológicos avançados parecem estar em todo o lado, presentes em todas as plataformas, como a Pesquisa Google, a aplicação Meteorologia da Apple ou mesmo no seu dispositivo doméstico inteligente.

Uma vez que a Google não está no negócio dos dados meteorológicos, tem de recorrer a uma API de terceiros para fornecer estes detalhes.

3. Reserva de viagens

Já se perguntou como é que os sítios de reservas de viagens conseguem agregar milhares de voos e destinos para encontrar a melhor oferta? A utilização de APIs de terceiros para reunir a disponibilidade de voos e hotéis dos fornecedores é muitas vezes a solução.

Do mesmo modo, se reservar uma viagem através de um destes fornecedores, as API serão utilizadas para validar a viagem com o fornecedor de onde provém. As API são benéficas para os serviços de viagens porque permitem que as máquinas partilhem dados e pedidos de forma fácil e autónoma.

4. Bots do Twitter

A vasta gama de bots disponíveis no Twitter é outro exemplo de APIs em ação.

Os bots do Twitter são contas que, com base em instruções de software, automaticamente tweetam (ou retweetam), seguem e enviam mensagens diretas. A API do Twitter também pode notificar os bots quando algo específico ocorre no site, além de permitir a realização de acções básicas como tweetar uma frase específica ou seguir um utilizador.

5. Pagar com Paypal

Já alguma vez utilizou o PayPal para efetuar uma compra numa loja online?

Isso é, de facto, uma API em funcionamento. A funcionalidade "Pagar com PayPal" foi concebida com APIs para garantir que a aplicação final só pode fazer o que precisa sem ser exposta a dados sensíveis ou obter acesso a permissões não pretendidas.

API REST

A API REST, também conhecida como serviço Web RESTful, baseia-se na transferência de estado representacional, um estilo de arquitetura de comunicação e uma abordagem frequentemente utilizados no desenvolvimento de serviços Web. Utiliza JSON como formato de dados baseado em URIs (Uniform Resource Identifiers, em que um URL é um tipo específico) e no protocolo HTTP.

Restrições de recursos, requisitos de segurança reduzidos, compatibilidade com o cliente do navegador, acessibilidade, integridade dos dados e escalabilidade - todos os aspectos relacionados com os serviços Web - são apenas algumas das razões pelas quais se pretende criar uma API RESTful.

As APIs REST podem ser fáceis de criar e escalar, mas também podem ser vastas e difíceis de gerir.

Vantagens

O REST é mais versátil e mais fácil de utilizar. Quando comparado com o SOAP, oferece as seguintes vantagens:

• Curva de aprendizagem mais pequena
• O REST permite muitos formatos de dados diferentes, incluindo texto simples, HTML, XML e JSON.
• Rápido (não é necessário um processamento exaustivo)
• Pode ser armazenado em cache
• Requer menos recursos e é leve
• Suporta HTTPS e SSL
• Optimizado para a Web
• Comunidade mais alargada

Desvantagens

Os programadores terão de enfrentar alguns desafios com as API REST. Eis os principais problemas que poderão surgir:

• Tempos de resposta longos e excesso de dados - o tamanho dos recursos devolvidos irá aumentar com o tempo, aumentando a carga e os tempos de resposta.
• Consistência dos pontos de extremidade - os caminhos dos pontos de extremidade devem ser consistentes, aderindo às normas universais da Web, o que pode ser difícil de manter.
• Segurança
• Autenticação - utilize autenticação simples HTTP, chaves API, Tokens Web JSON e outros tokens de acesso.
• Versões da API - os URL dos pontos de extremidade não devem ser invalidados quando utilizados internamente ou com outras aplicações

Exemplo: WebScrapingAPI

Já alguma vez precisou de reunir vários dados sobre um determinado assunto? Se sim, provavelmente procurou em várias páginas a informação de que precisava. Este processo pode ser exaustivo se for efectuado manualmente. Quer se trate de um estudo de mercado, geração de contactos, análise da concorrência ou mesmo de informações sobre produtos, é aqui que o WebScrapingAPI entra em ação.

A WebScrapingAPI é também uma API RESTful. Tal como o nome indica, é uma API que o ajuda a recolher todas as fontes online. Não tem de a importar, instalar ou configurar e tem várias vantagens: é leve, fácil de utilizar, fiável e flexível.

Ponto de bónus: O WebScrapingAPI oferece 1000 pedidos gratuitos para testar a aplicação. Isso é mais do que suficiente para o que vamos fazer.

API SOAP

O SOAP (Simple Object Access Protocol) é o seu próprio protocolo e é um pouco mais complexo do que o REST. Atualmente, é utilizado principalmente para expor serviços Web e enviar dados através de HTTP/HTTPS.

Ao contrário do padrão REST, o SOAP apenas suporta o formato de dados XML e segue rigorosamente as normas pré-definidas, como a estrutura de mensagens, as regras de codificação e uma convenção de pedido e resposta de processo.

Embora a maioria dos dados da Web seja trocada através de REST, o SOAP não vai desaparecer tão cedo porque é mais estruturado, permite a automatização em alguns casos e é mais estável.

Vantagens

Em comparação com o REST, o SOAP tem as seguintes vantagens

• Segurança melhorada - O WS-Security é uma norma integrada que fornece ao SOAP uma funcionalidade de segurança adicional de nível empresarial, para além do suporte SSL.
• Conformidade ACID (Atomicidade, Consistência, Isolamento e Durabilidade) incorporada - ao especificar com precisão a forma como as transacções podem comunicar com a base de dados, a conformidade ACID evita inconsistências e preserva a integridade da base de dados.
• Normalizado
• Tratamento de erros incorporado
• Suporta ambas as abordagens (com e sem estado)
• Automatização
• Vários protocolos de transferência (HTTP/HTTPS, FTP, TCP, SMTP, XMPP)

Desvantagens

Vejamos alguns dos desafios mais significativos que o SOAP traz.

• Não pode ser armazenado em cache
• Curva de aprendizagem difícil - geralmente requer um conhecimento mais aprofundado das normas e protocolos WS adicionais
• Consumo de recursos - requer mais recursos e largura de banda
• Utiliza apenas XML como formato de dados, que pode ser volumoso
• Comunidade mais pequena
• Falta de flexibilidade - torna a atualização dos pedidos e das respostas uma tarefa morosa, o que atrasa a adoção.

Exemplo: Transacções bancárias e sistemas de pagamento

Quando se trata de garantir que as suas transacções continuam a ser seguras e inalcançáveis por terceiros, a implementação de uma API SOAP pode ser uma boa prática. Uma vez que os processos de pagamento incluem frequentemente várias partes numa única transação, o SOAP permite uma melhor coordenação do seu comportamento.

As API existem para resolver problemas. Escolha a que mais lhe convém

Quando se trata de APIs de serviços Web, a maioria dos programadores prefere a arquitetura RESTful simplesmente porque utiliza menos largura de banda e é mais fácil de compreender, tanto para os programadores que criam APIs iniciais como para outros programadores que possam escrever serviços com base nelas.

As API RESTful foram amplamente adoptadas e são agora consideradas como a espinha dorsal da Internet.

O SOAP, por outro lado, também é útil em determinadas situações. Além disso, não é preciso procurar muito para encontrar apoiantes entusiastas do SOAP para casos de utilização específicos.

Apesar das suas muitas diferenças, ambos os modelos de API têm uma coisa em comum: existem para facilitar a nossa vida. Com o tempo, talvez novos tipos de APIs surjam e tornem a comunicação entre softwares ainda mais fácil. Só podemos ter esperança.

Se quiser ver mais exemplos de APIs em ação, simplificando o nosso trabalho e resolvendo problemas, veja como uma API pode resolver os desafios da raspagem da Web!