Entendendo a API REST do WordPress: Um guia para desenvolvedores

Introdução

Criar um site é um processo complexo e de várias etapas. Para começar, primeiro você precisa encontrar uma solução de hospedagem de qualidade para isso. Se você for criar um novo site e não tiver uma demanda muito alta de recursos nem uma expectativa de tráfego muito alta, um servidor VPS é uma solução versátil que será adequada para a maioria dos sites. Se o método de pagamento for importante para você, saiba que é possível escolher entre uma variedade de opções, como VPS de cartão de crédito, VPS de bitcoin, VPS de AliPay etc.

Outro aspecto fundamental da criação de um site é a escolha de um CMS - sistema de gerenciamento de conteúdo, uma ferramenta especial que é usada para preencher o site com conteúdo e modificá-lo. Se a sua escolha for o WordPress, seus desenvolvedores terão de lidar com a API REST do WordPress.

O Wordpress é um dos CMS mais populares para criar um site atualmente. A API REST, por sua vez, é uma interface essencial usada para trabalhar com um site do Wordpress. Graças à API REST, seus aplicativos têm a possibilidade de interagir com seu site por meio de arquivos JSON. Dessa forma, os desenvolvedores podem criar aplicativos, sites e plug-ins personalizados sobre o Wordpress. A API REST permite que os desenvolvedores interajam com os dados do Wordpress por meio de comandos HTTP.

A seguir, daremos uma olhada em alguns comandos essenciais que serão úteis para qualquer desenvolvedor.

API REST do WordPress: Fundamentos

OBTER:

Ele é usado para recuperar dados do banco de dados do WordPress usando o método HTTP GET. Esse comando é um dos mais comuns, sendo o primeiro comando que você usa antes de realmente fazer algo com seus dados.

Ele permite a recuperação de um recurso específico, como um post, uma página ou um tipo de post personalizado, sem modificá-lo.

Para usar o método, você precisa enviar uma solicitação a um ponto de extremidade específico com um determinado conjunto de parâmetros. O ponto de extremidade é apresentado por uma URL do recurso com os parâmetros que você deseja recuperar - por exemplo, a ID do recurso, as opções de filtragem, as informações de paginação e outros parâmetros de consulta.

Se você digitar isso:

GET http://yoursite.com/wp-json/wp/v2/posts/983

você obterá os detalhes da postagem com esse ID específico, como título, conteúdo, autor e outros metadados.

Além disso, você pode obter as informações em uma lista de recursos. Por exemplo, se quiser ver todos os recursos publicados, você deve adicionar /wp/v2/posts?status=publish à solicitação do endpoint:

GET http://yoursite.com/wp-json/wp/v2/posts?status=publish

POST:

Esse comando é usado para adicionar algo novo ao seu site. Na verdade, isso pode ser uma postagem, mas também pode ser usado para páginas, comentários e outros anexos.

Para criar uma nova postagem, adicione /wp/v2/posts ao endpoint.

POST http://yoursite.com/wp-json/wp/v2/posts

Em seguida, no payload, você poderá incluir os dados do novo post, como título, conteúdo, autor e outros metadados:

"title": "My New Post", "content": "Este é o conteúdo de minha nova postagem.", "author": 1, "status": "publish" (publicar)

PUT:

O POST é usado para criar rascunhos vazios para páginas e posts. Para atualizar um deles com novo conteúdo, você pode usar o comando PUT. Isso também pode ser usado para publicar rascunhos criados anteriormente.

Para ver todos os rascunhos atuais, você pode usar o comando POST desta forma:

POST http://yoursite.com/wp-json/wp/v2/posts/?status="draft".

Depois disso, você pode usar o comando PUT para modificar o status de um rascunho específico inserindo seu ID:

PUT http://yoursite.com/wp-json/wp/v2/posts/983

Isso acessará sua postagem com uma opção para modificá-la. Agora você precisa mudar seu status de "rascunho" para "publicar":

"status" = "publish" (publicar)

Além disso, você pode adicionar mais conteúdo a ele usando o argumento "status":

"status" = "publish" "content" = "content here" (conteúdo aqui)

EXCLUIR:

Outro comando essencial usado para excluir publicações, páginas, conteúdo e usuários. Uma publicação excluída será colocada primeiro na lixeira.

Para excluir uma postagem específica, por exemplo, a que foi criada acima, digite algo assim:

DELETE http://yoursite.com/wp-json/wp/v2/posts/983

Se quiser excluir a postagem definitivamente sem enviá-la para a lixeira, adicione ?force=true depois dela:

DELETE http://yoursite.com/wp-json/wp/v2/posts/983?force=true

OPÇÕES:

Se você quiser verificar um recurso quanto às opções de comunicação disponíveis para ele, poderá usar esse comando. Ao digitar o comando, na saída, você obterá a lista de métodos de comunicação disponíveis para um determinado recurso, juntamente com algumas outras informações relevantes, como esquemas de autenticação suportados, cabeçalhos de solicitação e tipos de conteúdo.

CABEÇA:

Esse comando permite a recuperação dos cabeçalhos do conteúdo sem ter de lidar com o conteúdo real. Dessa forma, um desenvolvedor pode obter as informações necessárias sobre partes do conteúdo, como informações de cache, tipo de conteúdo e duração do conteúdo, sem a necessidade de fazer download.

PATCH:

Esse comando permite que você atualize uma parte específica de um conteúdo. É um pouco semelhante ao PUT, mas você não precisa substituir totalmente um determinado recurso. Dessa forma, você pode atualizar o título ou o conteúdo de uma publicação, bem como os metadados associados a um usuário, enquanto o restante permanece o mesmo.

Ao usar o comando, você precisa especificar quais alterações deseja fazer. Por exemplo, para editar o título, você terá que adicionar isso ao corpo da solicitação:

"title": "Título da nova postagem"

Conclusão

A API REST do WordPress é uma interface multifuncional que permite que seus aplicativos interajam com o site do WordPress. A interface é gerenciada com a ajuda de vários comandos, aos quais dedicamos o artigo de hoje. Esperamos que essas informações tenham sido úteis. Agradecemos sua atenção!