API REST vs. API SOAP: qual escolher?

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

As APIs 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 são acessíveis ao público em geral.

As APIs internas, também conhecidas como APIs privadas, são criadas para uso interno dentro de uma organização. As equipas internas da empresa utilizam este tipo de API para desenvolver os seus produtos e serviços.

As APIs compostas são úteis em arquiteturas de microsserviços, onde um utilizador pode precisar 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 APIs compostas podem minimizar a carga do servidor e aumentar o desempenho da aplicação.

As APIs estão em todo o lado, a impulsionar as nossas vidas nos bastidores, mesmo que não nos apercebamos disso. Compilámos uma lista dos cinco exemplos mais comuns de utilização de APIs no nosso dia-a-dia para o ajudar a compreender melhor o que são as APIs 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.

Um exemplo típico de utilização de API é a funcionalidade «iniciar sessão através do Facebook/Twitter/Google» encontrada em muitos sites. É vantajoso, mas já pensou como funciona?

Em vez de iniciar sessão explicitamente nas contas das redes sociais dos utilizadores (o que representaria um risco de segurança significativo), estes sites utilizam as APIs destas plataformas para autenticar o utilizador em cada início de sessão.

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

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

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

Alguma vez já se perguntou como é que os sites de reservas de viagens conseguem agregar milhares de voos e destinos para encontrar a melhor oferta? A utilização de APIs de terceiros para recolher a disponibilidade de voos e hotéis junto dos fornecedores é frequentemente a solução.

Da mesma forma, se reservar uma viagem através de um destes fornecedores, as APIs serão utilizadas para validar a viagem junto do fornecedor de onde foi obtida. As APIs 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.

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, tweetam (ou retweetam), seguem e enviam mensagens diretas automaticamente. A API do Twitter também pode notificar os bots quando algo específico ocorre no site, além de permitir que você execute ações básicas, como tweetar uma frase específica ou seguir um utilizador.

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

Isso é, de facto, uma API em ação. A funcionalidade «Pagar com PayPal» foi concebida com APIs para garantir que a aplicação final só pode fazer o que é necessário, sem ser exposta a dados sensíveis ou obter acesso a permissões indesejadas.

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

Restrições de recursos, requisitos de segurança reduzidos, compatibilidade com navegadores, acessibilidade, integridade dos dados e escalabilidade — tudo o que está relacionado com serviços web — são apenas algumas das razões pelas quais se pode querer 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.

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

• Curva de aprendizagem mais suave
• O REST permite muitos formatos de dados diferentes, incluindo texto simples, HTML, XML e JSON.
• Rápido (não requer processamento extensivo)
• Pode ser armazenado em cache
• Requer menos recursos e é leve
• Suporta HTTPS e SSL
• Otimizado para a web
• Comunidade mais vasta

Os programadores irão enfrentar alguns desafios com as APIs REST. Aqui estão os principais problemas que poderá enfrentar:

• 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 endpoints — os caminhos dos endpoints devem ser consistentes, aderindo a padrões universais da web, o que pode ser difícil de manter.
• Segurança
• Autenticação — utilize autenticação simples HTTP, chaves de API, JSON Web Tokens e outros tokens de acesso.
• Versões da API — os URLs dos endpoints não devem ser invalidados quando utilizados internamente ou com outras aplicações

Alguma vez precisou de recolher vários dados sobre um tema específico? Se sim, provavelmente pesquisou inúmeras páginas à procura da informação de que precisava. Este processo pode ser exaustivo se o fizer manualmente. Quer se trate de pesquisa de mercado, geração de leads, análise da concorrência ou mesmo inteligência de produto, é aqui que a WebScrapingAPI entra em ação.

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

Ponto extra: a WebScrapingAPI oferece 1000 pedidos gratuitos para testar a aplicação. Isso é mais do que suficiente para o que vamos fazer.

SOAP (Simple Object Access Protocol) é um protocolo próprio e é um pouco mais complexo do que o REST. Atualmente, é usado principalmente para expor serviços web e enviar dados via HTTP/HTTPS.

Ao contrário do padrão REST, o SOAP suporta apenas o formato de dados XML e segue rigorosamente os padrões predefinidos, tais como a estrutura de mensagens, regras de codificação e uma convenção de processamento de pedidos e respostas.

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

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

• Segurança reforçada — o WS-Security é um padrão integrado que fornece ao SOAP funcionalidades de segurança adicionais de nível empresarial, para além do suporte a SSL.
• Conformidade ACID (Atomicidade, Consistência, Isolamento e Durabilidade) integrada — ao especificar com precisão como as transações podem comunicar com a base de dados, a conformidade ACID evita inconsistências e preserva a integridade da base de dados.
• Padronizado
• Tratamento de erros integrado
• Suporta ambas as abordagens (com estado e sem estado)
• Automatização
• Vários protocolos de transferência (HTTP/HTTPS, FTP, TCP, SMTP, XMPP)

Vamos dar uma olhada em alguns dos desafios mais significativos que o SOAP traz.

• Não pode ser armazenado em cache
• Curva de aprendizagem difícil — geralmente requer uma compreensão mais aprofundada das normas e de protocolos WS adicionais
• Consome muitos recursos — requer mais recursos e largura de banda
• Utiliza apenas XML como formato de dados, o que pode ser pesado
• Comunidade mais pequena
• Falta de flexibilidade — torna a atualização de pedidos e respostas uma tarefa demorada, o que atrasa a adoção.

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

No que diz respeito às 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 as APIs iniciais como para outros programadores que possam escrever serviços com base nela.

As APIs RESTful têm sido amplamente adotadas e são agora consideradas a espinha dorsal da Internet.

O SOAP, por outro lado, também é útil em determinadas situações. Além disso, não terá de procurar muito para encontrar entusiásticos defensores 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 surjam novos tipos de APIs e tornem a comunicação entre softwares ainda mais fácil. Só nos resta esperar.

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 do web scraping!