O WordPress é um sistema de gerenciamento de conteúdo (CMS) sofisticado, equipado com um vasto ecossistema de temas e plugins, proporcionando inúmeras possibilidades para ampliar a funcionalidade do seu site. Nos momentos em que você busca expandir as capacidades do seu site de maneira única, recorrer a APIs de terceiros é a solução ideal.

Neste artigo, vamos abordar as vantagens de utilizar APIs de terceiros junto ao WordPress. Durante a leitura, você conhecerá os diversos tipos de APIs à disposição, receberá orientações para selecionar as mais apropriadas e muito mais. O foco principal será em como implementar APIs de terceiros em um site WordPress que esteja hospedado na Kinsta.

Há muito o que fazer, então vamos começar!

O que são APIs de terceiros

Uma API (Interface de Programação de Aplicativos) é um conjunto de regras e protocolos que permite que diferentes aplicativos se comuniquem e interajam. As APIs são intermediárias, pois permitem que você acesse dados específicos de serviços externos.

Depois de ter acesso aos dados disponíveis, você pode trazê-los para seus próprios aplicativos. A abordagem típica é usar uma linguagem apropriada, como cURL, JavaScript, Python ou PHP.

Um trecho de código da API Tinify do TinyPNG.
Um trecho de código da API Tinify do TinyPNG.

O WordPress oferece APIs primárias, como a API REST, que revelam “endpoints” no núcleo do código, possibilitando aos desenvolvedores a conexão com elas. Essa abordagem geralmente oferece maior amplitude e flexibilidade do que a utilização de um plugin.

Obviamente, a Kinsta também fornece uma API REST para você se conectar e trabalhar com sua plataforma fora do painel MyKinsta. Isso permitirá que você realize tarefas como a recuperação de registros do servidor, a configuração de sites e muito mais.

Quando você utiliza a API de uma plataforma para acessar seus endpoints, isso é considerado um uso primário. Por outro lado, ao utilizar a API de um serviço dentro de outro contexto, isso caracteriza o uso de uma API de terceiros. Por exemplo, é possível acessar os endpoints da API Weather do OpenWeatherMap diretamente pelo código do seu site WordPress.

A página da API do OpenWeather.
A página da API do OpenWeather.

Como você pode esperar, isso pode ampliar significativamente o escopo do que é possível realizar com o WordPress, a Kinsta e o seu site.

Os benefícios de usar APIs de terceiros com o WordPress

O uso de plugins com o WordPress é, obviamente, um grande ponto positivo para a plataforma. Mesmo assim, também há muitos pontos positivos na integração de APIs de terceiros com seu site. O maior deles é como você pode “codificar” praticamente qualquer funcionalidade que desejar em seu site.

Essa não é a história completa, mas, em geral, uma API dará a você mais poder e versatilidade em potencial do que o WordPress e seus plugins podem oferecer.

Aqui estão algumas outras vantagens importantes:

  • Você pode economizar no tempo de desenvolvimento. Você pode economizar tempo de desenvolvimento. É mais rápido aproveitar uma API de terceiros existente para criar funcionalidades do que fazer isso do zero. Isso deve economizar tempo e permitir que você se concentre em outras áreas do projeto.
  • Você pode personalizar a experiência do usuário (UX). É possível realizar qualquer funcionalidade que os usuários queiram ver no local de acordo com suas preferências exatas usando APIs de terceiros.
  • Você terá um aumento na eficiência do projeto. As APIs permitem que você automatize e simplifique os processos. Por exemplo, você pode integrar uma API de marketing por e-mail para sincronizar e automatizar os dados do usuário em uma plataforma relevante.
  • A manutenção não é de sua responsabilidade. O desenvolvedor de uma API de terceiros fará a manutenção e a atualização. Isso garante que você tenha acesso aos recursos e aprimoramentos mais recentes sem investir recursos extras.

As APIs de terceiros serão valiosas em qualquer lugar em que você queira ter integração, personalização e desempenho supremos. Obviamente, essa será sua única opção se não houver nenhum plugin de WordPress disponível para atender às suas necessidades.

Em geral, se houver a necessidade de personalizar a funcionalidade, como ajustar configurações, o uso de um plugin pode ser mais adequado. Contudo, ainda assim existem diversas maneiras de integrar funcionalidades ao seu site por meio do uso de APIs de terceiros.

Os tipos de APIs de terceiros que você pode encontrar

A demanda por APIs, em geral, é enorme. Um relatório do Google Cloud observa que cerca de 60% dos aplicativos web utilizam APIs. Esse mesmo relatório destaca que a maioria dos líderes acredita que as APIs contribuem para a criação de produtos melhores.

Embora avaliar o valor objetivo das APIs de terceiros possa ser desafiador, é evidente que elas possuem uma ampla gama de usos específicos. Consequentemente, as APIs de terceiros disponíveis são projetadas para satisfazer diversas necessidades e funcionalidades:

  • APIs de mídia social. Quase todas as plataformas, como Facebook, Twitter, TikTok e Instagram, fornecem APIs. Isso dá a você a capacidade de integrar compartilhamento social, opções de login, incorporação e outros recursos sociais.
  • APIs de gateway de pagamento. Você encontrará muitos gateways de pagamento diferentes com APIs. Por exemplo, o Stripe e o PayPal permitirão que você integre essas ofertas de serviços ao seu site WordPress.
  • APIs de mapeamento. Com serviços como o Google Maps e o Mapbox, você pode incorporar mapas interativos, aplicar geolocalização e adicionar rotas ao seu site.
  • APIs de análise. Você tem muitas opções quando se trata de análise. As APIs do Google são novamente populares aqui, pois muitos proprietários de sites procuram trazer o Lighthouse e os dados analíticos para o WordPress.
  • APIs de marketing por e-mail. Serviços como o Mailchimp e o SendGrid permitem que você integre suas APIs ao WordPress também. Isso permite que você automatize campanhas de e-mail, gerencie assinantes, acompanhe o desempenho e muito mais.
  • APIs de clima. Com APIs de sites como OpenWeatherMap e Weatherbit, você pode fornecer dados meteorológicos em tempo real. Considerando a complexidade de que você precisa, também é possível adicionar elementos como geolocalização.

Essa não é uma lista completa de tipos de API, e há inúmeras outras APIs disponíveis para várias finalidades. Dada a variedade de opções, é fundamental que você escolha a API certa para integrar. Faremos isso a seguir, antes de investigarmos como integrar APIs de terceiros ao WordPress.

Como selecionar as APIs de terceiros adequadas para suas necessidades

Da mesma forma que existe uma lista de critérios a considerar ao escolher um plugin de WordPress, um processo similar se aplica na escolha da API de terceiros. É crucial selecionar suas integrações de maneira criteriosa, uma vez que isso definirá o rumo do seu projeto.

Sua principal preocupação é identificar a funcionalidade de que seu site precisa. Parece óbvio, mas você deve procurar APIs que ofereçam a combinação certa de recursos e funcionalidades para você.

No entanto, há outros fatores que você deve ter em mente ao escolher APIs de terceiros:

  • Confiabilidade e reputação. É aqui que você verifica as avaliações dos usuários, classificações e o histórico do fornecedor. Juntos, esses elementos indicarão se possuem uma boa reputação em oferecer serviços confiáveis.
  • Documentação e suporte. A qualidade da documentação ajudará você a acessar os endpoints. Juntamente com o nível de suporte que você obtém do provedor de API, você pode economizar tempo e também reduzir os esforços de solução de problemas.
  • Preços. Nem todas as APIs são gratuitas. Algumas oferecem níveis gratuitos com limitações, enquanto outras usam um modelo de preço premium. Assim, certifique-se de que você alinhe seu orçamento, o custo da API, o uso esperado e o acesso.
  • Segurança e privacidade. A segurança dos dados do usuário é primordial ao utilizar uma API de terceiros. Essa questão deve ser avaliada com rigor. É necessário verificar as medidas de segurança implementadas pela API, assim como sua conformidade com os padrões de proteção de dados do setor. Atribua pontos adicionais se ela estiver alinhada com os regulamentos de privacidade de dados aplicáveis.

Uma API costuma ser uma solução de longa duração, o que implica que ela deve ser útil independentemente da escala do seu site. Vamos explorar mais detalhadamente esse aspecto agora.

Escalabilidade

A API selecionada deve ser capaz de suportar o crescimento do tráfego e do uso conforme seu site expande. Essa capacidade de escalabilidade é uma consideração crucial, e é por isso que decidimos dar uma atenção especial a ela neste ponto.

A API deve ser capaz de fornecer o que você precisa, independentemente do volume de tráfego do seu site. No entanto, muitas vezes é difícil descobrir se uma API é capaz de atender às necessidades. Pode ser necessário que você faça uma estimativa com base na forma como o provedor da API descreve sua oferta.

Por exemplo, as APIs “stateless” usam um design de servidor mais simples e têm flexibilidade quando se trata de recursos de processamento. O escalonamento horizontal adiciona mais nodes e máquinas à rede do servidor. Isso proporciona a você o máximo de potência de recursos que precisar em comparação com o escalonamento vertical. A “assincronização” permite que o servidor processe múltiplos pedidos simultaneamente, o que é mais eficiente.

Uma diferença visual entre uma configuração não escalável e uma configuração de escalonamento horizontal de uso geral.
Uma diferença visual entre uma configuração não escalável e uma configuração de escalonamento horizontal de uso geral. (Crédito da imagem: Nithin Mohan)

Você também deve verificar se uma taxa de API limita suas permissões de solicitação. A longo prazo, isso proporcionará a você um serviço mais consistente, confiável e estável sob cargas pesadas.

Mesmo assim, você deve avaliar todos esses fatores com cuidado. Escolher as APIs de terceiros certas que atendam aos seus requisitos será uma vantagem quando você quiser integrá-las ao WordPress.

Práticas e dicas típicas para integrar APIs de terceiros ao WordPress

A integração de uma API ao seu site geralmente é simples. Mesmo assim, você ainda precisa de uma abordagem sistemática para garantir uma integração tranquila.

Sua primeira ação deve ser RTFM – leia o manual detalhadamente. A documentação da API deve ser clara quanto à funcionalidade com a qual você pode trabalhar. Isso inclui detalhes sobre os endpoints, parâmetros e métodos de autenticação disponíveis.

Documentação da API da Kinsta
Documentação da API da Kinsta

No entanto, há muitas outras dicas e práticas típicas para você ter sucesso na integração de sua API com o WordPress:

  • Como lidar com a autenticação. A maioria das APIs precisa de credenciais de autenticação para acessar seus serviços. Sem elas, você não conseguirá acessar nenhum endpoint.
  • Implementação de chamadas API. O WordPress oferece a você vários métodos para fazer chamadas API, como a API HTTP integrada. Vale a pena dedicar algum tempo para escolher o método certo que melhor atenda às suas necessidades. Novamente, a documentação da API ajudará você aqui.
  • Analise as respostas da API. As APIs retornarão respostas em vários formatos, como JSON ou XML. Dessa forma, você terá que analisar e manipular essas respostas da API no seu código para extrair e usar os dados.
  • Como lidar com o tratamento de erros. A implementação de mecanismos apropriados de tratamento de erros pode facilitar o manejo dos erros de API de maneira tranquila. Além disso, possibilita a apresentação de mensagens de erro relevantes aos visitantes do seu site.
  • Testes e depuração. Como em qualquer aplicativo ou implementação, é importante testar a integração da API para confirmar seu funcionamento conforme o esperado. Ferramentas como o Postman ou as ferramentas para desenvolvedores disponíveis em navegadores podem ser úteis para testar as chamadas de API e depurar possíveis problemas.

Por fim, é importante que você acompanhe o uso da API. Como os custos estão geralmente relacionados a uma permissão de uso, você deve procurar manter-se dentro desses limites. Mais adiante, mostraremos a você como as ferramentas da Kinsta podem ajudar com isso.

Preparando o WordPress e a Kinsta para integração com APIs de terceiros

Antes de você integrar APIs de terceiros ao WordPress, é fundamental que tanto a plataforma quanto a Kinsta estejam prontas para lidar com isso. Muitas vezes, pode ser necessário configurar o CMS e o provedor de hospedagem web, especialmente para um novo site.

A boa notícia é que essa etapa contém muitas tarefas típicas e simples. Por exemplo, você deverá manter o núcleo do WordPress atualizado. A instalação de todos os plugins necessários também deve ser uma prioridade. Algumas APIs podem precisar de plugins específicos para funcionar ou ser usadas como uma “ponte” para o seu site.

As considerações de segurança também devem fazer parte de seus preparativos. Você precisará habilitar o HTTPS em seu site por meio da instalação de um certificado SSL (Secure Sockets Layer).

As informações de SSL para um certificado Let's Encrypt.
As informações de SSL para um certificado Let’s Encrypt.

Realizar o backup do seu site antes de qualquer alteração significativa é sempre uma boa prática, portanto, essa etapa é fundamental. Adicionalmente, é importante avaliar se sua integração deve começar em um ambiente de desenvolvimento local. É possível que alguns plugins não funcionem adequadamente em uma configuração local.

Este é também o momento para verificar as limitações impostas pelo seu provedor de hospedagem web em relação ao uso de APIs de terceiros. Isso pode incluir limitações como taxas de transferência limitadas ou portas bloqueadas. Ter essa informação em mãos pode ser crucial para desenvolver a funcionalidade desejada de maneira eficiente.

Por exemplo, a Kinsta bloqueia todas as portas SMTP padrão, pois não fornecemos hospedagem de e-mail. Além disso, limita as solicitações a 60 por minuto. Contudo, uma vez que o WordPress e a Kinsta estejam otimizados e configurados para operar, você estará apto a iniciar a integração com suas APIs de terceiros.

Como integrar APIs de terceiros com o WordPress na Kinsta (2 métodos)

A abordagem típica quando se trata de integração de APIs de terceiros é codificá-las. No entanto, essa não é a única maneira de proceder.

Agora, vamos analisar as duas principais abordagens para integrar APIs de terceiros com o WordPress na Kinsta. Vamos começar com a abordagem manual e, em seguida, dar uma olhada nos plugins de WordPress.

1. Faça solicitações HTTP para a API por meio de codificação direta

A maneira mais comum de implementar chamadas de API e lidar com a resposta é codificá-la em seu site. Para isso, você precisará de um bom conhecimento da linguagem de programação que escolheu e da estrutura do WordPress.

Para sites WordPress, você deve usar as rotas e os endpoints da API REST. Eles não são apenas seguros, mas também oferecem a melhor integração com seu site.

As APIs do TikTok são todas excelentes, pois a codificação da funcionalidade segue uma abordagem típica. Vamos dar uma olhada em como você pode fazer isso.

Como integrar a API do TikTok ao WordPress

Primeiro, você precisa ter uma conta de desenvolvedor na plataforma. Esse processo de inscrição é rápido e, nesse momento, você verá uma lista de APIs disponíveis:

O microsite do desenvolvedor do TikTok mostra duas das várias APIs disponíveis.
O microsite do desenvolvedor do TikTok mostra duas das várias APIs disponíveis.

Aqui, você pode escolher a API certa para suas necessidades e dar uma olhada na documentação. Neste exemplo, vamos integrar a API Display. Ela permite que você exiba informações de perfil e vídeos associados:

A API de exibição do TikTok.
A API de exibição do TikTok.

Outro pré-requisito é o TikTok Login Kit. Isso permite que você autentique seu aplicativo de desktop com a plataforma de mídia social. Fazer isso está além do escopo deste artigo, mas envolve um processo de registro e aprovação.

O uso do Login Kit também é necessário para obter o token de acesso para o perfil específico que você deseja exibir:

curl --location --request POST 'https://open.tiktokapis.com/v2/oauth/token/' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--header 'Cache-Control: no-cache' \
--data-urlencode 'client_key=CLIENT_KEY' \
--data-urlencode 'client_secret=CLIENT_SECRET' \
--data-urlencode 'code=CODE' \
--data-urlencode 'grant_type=authorization_code' \
--data-urlencode 'redirect_uri=REDIRECT_URI'

Com esse token de acesso, você pode chamar GET no endpoint /v2/user/info/. Isso retorna informações básicas sobre um usuário específico:

curl -L -X GET 'https://open.tiktokapis.com/v2/user/info/?fields=open_id,union_id,avatar_url' \
-H 'Authorization: Bearer act.example12345Example12345Example'

Isso deve retornar uma resposta dedicada da API contendo todas as informações relevantes no formato JSON:

{
   "data":{
      "user":{
         "avatar_url":"https://p19-sign.tiktokcdn-us.com/tos-avt-0068-tx/b17f0e4b3a4f4a50993cf72cda8b88b8~c5_168x168.jpeg",
         "open_id":"723f24d7-e717-40f8-a2b6-cb8464cd23b4",
         "union_id":"c9c60f44-a68e-4f5d-84dd-ce22faeb0ba1"
      }
   },
   "error":{
      "code":"ok",
      "message":"",
      "log_id":"20220829194722CBE87ED59D524E727021"
   }
}

Você precisará analisar essa resposta para identificar os dados específicos do seu interesse e exibi-los no frontend. Após estabelecer uma implementação funcional, é possível testar, depurar e implementar um tratamento de erros no código. No entanto, existe outra abordagem para configurar APIs de terceiros no WordPress e na Kinsta.

2. Utilize um plugin de WordPress como uma solução low-code para se conectar a APIs de terceiros

Existem plugins de WordPress projetados para facilitar a conexão com APIs de terceiros de maneira rápida e eficiente. Além disso, muitas vezes não é necessário ser um desenvolvedor para entender e usar esses plugins. Isso significa que é possível aproveitar todos os benefícios de se conectar a APIs sem a necessidade de programação.

Existem alguns plugins que podem ajudar você, como o Get Use APIs. No entanto, nossa preferência é o WPGetAPI, pois oferece muitas funcionalidades em sua versão gratuita.

A imagem do cabeçalho do plugin WPGetAPI do WordPress.org.
A imagem do cabeçalho do plugin WPGetAPI do WordPress.org.

Em seguida, vamos explorar como utilizar esse plugin para se conectar a uma API. No entanto, essas técnicas também podem ser aplicadas a outros plugins. Depois de instalar e ativar o plugin, você já pode começar a inserir os detalhes da sua API nele.

Como usar o WPGetAPI para se conectar a APIs de terceiros

Para este exemplo, usaremos a API de otimização de imagens do ShortPixel. Vá para a tela WPGetAPI > Setup, onde você verá uma série de campos em branco:

A tela principal do plugin WPGetAPI.
A tela principal do plugin WPGetAPI.

Primeiro, você precisará especificar três elementos: um nome de API, um ID exclusivo e a URL base da API.

Configurando as informações da API do ShortPixel no WPGetAPI.
Configurando as informações da API do ShortPixel no WPGetAPI.

Depois que você preencher essas informações e clicar no botão Save, haverá uma nova aba para especificar os endpoints. Os primeiros quatro campos dessa tela são essenciais para você preencher. Você precisará fornecer um ID exclusivo e uma URL de endpoint, especificar um método de solicitação e definir um formato de resultados:

Configurando uma chamada POST para a API do ShortPixel no WPGetAPI.
Configurando uma chamada POST para a API do ShortPixel no WPGetAPI.

No menu suspenso Request Method, você geralmente usará apenas dois: GET para obter dados da API e POST para enviar dados a ela.

O ShortPixel funciona enviando primeiro uma imagem, portanto, estamos usando um método POST. A maioria das solicitações de API também precisará de um método GET, para que seu site possa receber dados e enviá-los.

Existem alguns campos opcionais abaixo dos quatro principais que permitem definir limites de tempo para conexão e cache. Dependendo do seu método de autenticação, você irá inserir suas credenciais em um dos campos Query String, Headers ou Body. O ShortPixel, por exemplo, utiliza uma chave de API na string da URL, permitindo adicionar nos campos Query String:

Adicionando informações de chave de acesso ao campo Query String em WPGetAPI.
Adicionando informações de chave de acesso ao campo Query String em WPGetAPI.

Salve as alterações mais uma vez e, em seguida, volte à parte superior da tela para ver o botão Test Endpoints. Ao clicar nesse botão, você testará a conexão e retornará um relatório com o status da conexão:

Testando um endpoint no WPGetAPI.
Testando um endpoint no WPGetAPI.

A última tarefa para conectar a API ao WordPress é copiar o shortcode ou a tag de modelo na parte superior da tela:

Escolhendo um método de exibição de informações da API no WPGetAPI.
Escolhendo um método de exibição de informações da API no WPGetAPI.

Você pode inseri-los em um ponto relevante do seu código ou da sua página, conforme a sua preferência.

Avaliando o desempenho de APIs de terceiros usando o Kinsta APM

Um elemento-chave para a integração de APIs de terceiros no WordPress é o desempenho delas. Não faz sentido usar uma API se ela tiver um impacto negativo em seu site. É aqui que a ferramenta Kinsta APM entra em ação.

A tela do Kinsta APM no painel MyKinsta.
A tela do Kinsta APM no painel MyKinsta.

Isso possibilita a avaliação do desempenho objetivo do seu site através do painel MyKinsta. Ele oferece um conjunto útil de gráficos e métricas para auxiliar na avaliação da eficiência do seu site:

A ferramenta APM da Kinsta informa sobre os tempos de transação de um site.
A ferramenta APM da Kinsta informa sobre os tempos de transação de um site.

Há muito o que descobrir com o APM da Kinsta, mas usá-lo para monitorar seus “tempos de transação” é um caso de uso importante. Isso permite que você veja quais partes do seu site precisam de mais recursos.

Esteja atento ao impacto de todas as solicitações e processos HTTP externos e verifique se sua API está utilizando muitos recursos. Se estiver, é essencial otimizá-la para melhorar o desempenho. Ter acesso a essas métricas através do painel MyKinsta pode oferecer um lembrete quase constante das áreas em que seu site necessita de melhorias.

Resumo

A integração de APIs de terceiros com o WordPress na Kinsta pode ajudar você a ampliar a funcionalidade do seu site. Isso pode fazer com que você economize mais tempo de desenvolvimento, melhorando a experiência do usuário e aumentando a eficiência. Melhor ainda, o WordPress oferece a você algumas maneiras de conectar APIs de terceiros.

Você pode usar a API REST do WordPress ou até mesmo um plugin que faça o trabalho pesado para você. O WPGetAPI é um dos melhores e usa uma abordagem “low-code”, com uma interface amigável. Se você combinar isso com a ferramenta Kinsta APM, terá uma maneira objetiva de monitorar o desempenho do seu site usando uma solução “primária”.

Você acredita que vale a pena implementar APIs de terceiros no WordPress? Compartilhe sua opinião na seção de comentários abaixo!

Jeremy Holcombe Kinsta

Content & Marketing Editor at Kinsta, WordPress Web Developer, and Content Writer. Outside of all things WordPress, I enjoy the beach, golf, and movies. I also have tall people problems ;).