APIs do WordPress: o que são e como usá-las

Publicados: 2024-09-13

A API JSON REST do WordPress criou um grande burburinho na comunidade WordPress, oferecendo novas possibilidades para desenvolvedores e criadores de conteúdo.

Embora possa parecer complexo, compreender termos-chave como JSON, REST e API pode simplificar a forma como você interage com os amplos recursos do WordPress.

O que é uma API?

API significa “interface de programação de aplicativos”, que é essencialmente um conjunto de instruções e padrões de programação que permitem que diferentes aplicativos de software se comuniquem entre si.

Imagine um aplicativo de software dando instruções a outro – uma API é o conjunto de regras acordadas que regem essa interação. Quando um software envia instruções para outro, a API facilita a ação ou fornece as informações necessárias.

Você pode pensar em uma API como a “interface do usuário” entre dois sistemas de software, cuidando da comunicação de dados e da execução de tarefas, mas invisível para o usuário final.

um laptop em uma mesa de madeira

Exemplos de APIs

Ter acesso a uma API é incrível quando você desenvolve aplicativos da web. Quando uma API é lançada ao público, significa que os desenvolvedores criaram soluções que são alimentadas pelo serviço do software. Muitas vezes, eliminam a necessidade de reinventar a roda para muitas tarefas, uma vez que já foram criadas.

Um ótimo exemplo de API é a Amazon. A Amazon lançou sua API para que os desenvolvedores possam acessar facilmente os produtos e suas informações. Ter acesso facilita a postagem de links de produtos na Amazon, com preços atualizados e opção de compra.

Outro exemplo de interação entre APIs seria a compra de ingressos para shows. Para comprar ingressos oficialmente, você precisa inserir as informações do seu cartão de crédito. Uma API é usada para enviar as informações do seu cartão de crédito para um aplicativo remoto, que então verifica se as informações do cartão de crédito estão corretas.

Depois que tudo estiver confirmado, o aplicativo remoto enviará uma resposta ao site do ingresso dizendo que está tudo bem para prosseguir, momento em que você comprou os ingressos com sucesso. Quando tudo isso acontece, você vê apenas uma interface, que é o site do ticket. É um processo contínuo; nos bastidores, muitos aplicativos trabalham juntos usando APIs, mas você, como usuário, não percebe quando as tarefas são transferidas de um aplicativo para outro.

APIs e WordPress

A Amazon e as compras de ingressos são ótimos exemplos de como as APIs funcionam juntas, mas como isso se aplica ao WordPress?

Bem, todas as mesmas ideias se aplicam. Com a API do WordPress, você pode enviar e extrair dados para dentro e para fora do WordPress.

A API é uma ferramenta importante que os desenvolvedores podem usar para compartilhar facilmente dados de seu site WordPress com outros sites ou aplicativos. Especificamente, esta API permite executar ações create , read , update e delete (CRUD) no conteúdo do WordPress. Alguns exemplos de tipos de conteúdo são:

  • Postagens
  • Tipos de postagem personalizados
  • Páginas
  • Taxonomias
  • Usuários
  • Mídia

O que significa REST?

Não há cochilos ou roncos aqui – REST refere-se ao estilo arquitetônico de uma API. REST significa Transferência de Estado Representacional.

Lembra como mencionamos que uma API fornece detalhes de comunicação para que os programas possam se comunicar entre si? As APIs REST são projetadas de forma a fornecer um método leve de comunicação, que economiza largura de banda. A API JSON REST do WordPress faz exatamente isso, sendo uma ótima opção quando há um grande volume de dados.

Acabamos de arranhar a superfície do REST; se quiser saber mais, confira este tutorial útil do REST.

Formato JSON

Para acessar os dados, precisamos de uma fonte de onde extrair. É aqui que entra o JSON. JSON significa JavaScript Object Notation.

JSON é fácil de ler e entender tanto para humanos quanto para máquinas. É a maneira perfeita de armazenar informações de maneira organizada e de fácil acesso. Como o JSON é tão simples de acessar, ele é ideal para a criação de APIs REST e é a solução perfeita para a API JSON REST do WordPress.

Aqui está uma ideia básica de como é o formato JSON:

[javascript]
{"funcionários":[
{“primeiroNome”:”Jane”, “sobrenome”:”Smith”},
{“primeiroNome”:”Anna”, “sobrenome”:”Olsen”},
{“primeiroNome”:”Josh”, “sobrenome”:”Jones”}
]}

[/javascript]

Formato JSON no WordPress

JSON não se escreve apenas, mas não se preocupe, você não precisa criar manualmente o arquivo JSON. Existem plug-ins que podem criá-lo para você. Com uma dessas ferramentas, os dados do site estarão no formato correto, incluindo usuários, postagens, páginas, taxonomias e muito mais.

Usando a API JSON REST

Usar a API é bastante autoexplicativo; você obterá os dados do seu site em formato JSON simples. E se você tiver um plugin instalado, você pode brincar vendo as postagens do seu site em forma de dados.

Recuperar ou atualizar dados é tão simples quanto enviar uma solicitação HTTP. HTTP é um protocolo de solicitação/resposta. Primeiro, você envia uma solicitação de dados e, em seguida, os dados são enviados de volta como resposta.

Método GET

O método GET é usado para recuperar informações e não tem efeito nos dados. Basta enviar uma solicitação GET para /wp-json/wp/v2/posts . Quer pesquisar algo? Por exemplo, se você estiver pesquisando “desenvolvimento”, obterá os resultados com a solicitação GET /wp-json/wp/v2/posts?search=development .

Solicitação POST

Uma solicitação POST é usada para enviar dados. Com os recursos da nova API, por exemplo, você poderia atualizar um usuário. Digamos que você queira atualizar o usuário com o ID 10. Tudo o que você precisa fazer é enviar uma solicitação POST para /wp-json/wp/v2/users/10 .

Para testar isso, recomendamos usar o Postman, uma extensão do Google Chrome.

Mais Javascript na mistura

Backbone.js e APIs

Backbone.js é uma ótima maneira de trabalhar com API porque é uma estrutura projetada para trabalhar com APIs REST. A API do WordPress inclui uma API Javascript fácil de usar baseada em modelos Backbone. Isso permite que os desenvolvedores de plug-ins e temas comecem a trabalhar sem esforço e conhecimento profundos sobre os detalhes de como se conectar.

Há muito mais do que isso, mas o Backbone fornece estrutura para aplicativos da web, fornecendo modelos, coleções e visualizações, e conecta tudo à API do WordPress por meio de uma interface REST JSON.

logotipo da marca backbone.js

O que isso significa para os desenvolvedores do WordPress?

Com a disponibilidade da API do WordPress, novas formas de utilizá-la aumentaram e continuarão a aumentar à medida que ganha popularidade. A API do WordPress pode melhorar praticamente qualquer funcionalidade existente do WordPress que dependa de Javascript. Aqui estão alguns exemplos:

  • validação/envio de formulário
  • Temas ou plug-ins Backbone.js
  • rolagem infinita

Também é uma ótima maneira de mostrar conteúdo de outras fontes. Agora é fácil exibir conteúdo de um site individual em uma configuração multisite. Também é possível exibir conteúdo de um site WordPress totalmente separado. Além de mostrar o conteúdo, o conteúdo também pode ser atualizado de forma mais fácil e eficaz.


Agora que examinamos um pouco da terminologia básica, sabemos que JSON é a notação, REST é o estilo arquitetônico e API é a interface que eles compõem. Conhecer os fundamentos da API e seus recursos garantirá que você tenha um bom começo ao explorar as novas possibilidades com a API do WordPress.