Guia Completo para Desenvolvedores da API WordPress

Se você está desenvolvendo aplicações web, aplicativos móveis ou clientes front-end que precisam interagir programaticamente com um site WordPress, a API do WordPress é sua ferramenta chave. Com um site configurado corretamente e os endpoints REST fornecidos pelo WordPress (ou WordPress.com), você pode recuperar posts, criar novo conteúdo, editar páginas existentes, gerenciar usuários, comentários e muito mais — tudo via requisições HTTP padrão. Este guia o levará por como começar com a API do WordPress, como funciona a estrutura de URL, como realizar operações CRUD e como testar tudo em um navegador ou usando uma ferramenta de API como o Apidog.

💡

Quer uma ótima ferramenta de Teste de API que gera documentação de API bonita?

Quer uma plataforma integrada e completa para sua Equipe de Desenvolvedores trabalhar em conjunto com máxima produtividade?

Apidog entrega todas as suas demandas e substitui o Postman por um preço muito mais acessível!

button

Começando com a API do WordPress

a) Configuração de Conta ou Site

Se você estiver usando um site WordPress auto-hospedado (WordPress.org), certifique-se de que seu site esteja instalado e funcionando.

Se você estiver trabalhando com um site WordPress.com, faça login em WordPress.com e localize o Painel do seu site.

Certifique-se de que o acesso à API REST esteja ativado — por padrão, as instalações modernas do WordPress expõem a API REST do WP em seusite.com/wp-json/.

Nenhuma criação de conta adicional é necessária além de ter acesso ao site (e permissões apropriadas) — a API REST é integrada ao núcleo do WordPress e acessível por padrão.

b) Entendendo a Estrutura da URL Base

Para um site WordPress auto-hospedado, a URL base da API é:

https://seusite.com/wp-json/

Por exemplo, para recuperar posts você apontaria para:

https://seusite.com/wp-json/wp/v2/posts

Se os permalinks bonitos estiverem desativados, o WordPress ainda pode servir a API através de um fallback de parâmetro de consulta — mas na maioria das configurações modernas, /wp-json/ funciona diretamente.

Para sites hospedados no WordPress.com (ou sites usando a API REST do WordPress.com), a estrutura da URL pode diferir ligeiramente, dependendo do namespace e do identificador do site. Por exemplo:

https://public-api.wordpress.com/{namespace}/{version}/sites/{site_id}/...

Verifique a documentação oficial em Recursos para Desenvolvedores WordPress para um guia mais detalhado sobre a estrutura da URL base.

Usando a API REST do WordPress: Operações CRUD

A API do WordPress suporta todas as operações CRUD padrão — Criar, Ler, Atualizar, Excluir — usando o método HTTP apropriado (POST, GET, PUT, DELETE). Vamos detalhá-las com exemplos concretos que você pode testar no navegador ou usando o Apidog.

1. Ler: Recuperando Posts ou Páginas

Para obter uma lista de posts:

GET https://seusite.com/wp-json/wp/v2/posts

Para buscar um único post por ID:

GET https://seusite.com/wp-json/wp/v2/posts/{id}

Você pode adicionar parâmetros de consulta para filtrar ou paginar resultados — por exemplo:

GET https://seusite.com/wp-json/wp/v2/posts?per_page=5&page=2

GET https://seusite.com/wp-json/wp/v2/posts?status=draft

Você também pode controlar quais campos são retornados usando o parâmetro de consulta _fields (por exemplo, ? _fields=id,title,excerpt,link) para reduzir o tamanho da carga útil e melhorar o desempenho.

O mesmo se aplica a páginas (via /wp-json/wp/v2/pages) ou outros tipos de recursos como mídia, comentários, etc., dependendo do que seu site expõe.

2. Criar: Adicionando um Novo Post

Se você estiver autenticado (como administrador ou usuário com permissões), pode criar um novo post via:

POST https://seusite.com/wp-json/wp/v2/posts

Com um corpo JSON, por exemplo:

{
  "title": "Meu Novo Post da API",
  "content": "Este post foi criado via API do WordPress.",
  "status": "publish"
}

Esta requisição criará um novo post. Opcionalmente, você pode definir o status como "draft" ou outros status válidos se não quiser publicar imediatamente.

3. Atualizar: Editando um Post Existente

Para atualizar um post por ID (por exemplo, atualizando seu título ou conteúdo):

PUT https://seusite.com/wp-json/wp/v2/posts/{id}

Exemplo de corpo:

{
  "title": "Título Atualizado via API",
  "content": "Conteúdo atualizado da API."
}

Alternativamente, algumas implementações aceitam PATCH. Após uma requisição bem-sucedida, a API responde com o objeto de post atualizado.

4. Excluir: Removendo um Post

Para excluir um post por ID:

DELETE https://seusite.com/wp-json/wp/v2/posts/{id}

Por padrão, isso geralmente move o post para a Lixeira (se a lixeira estiver ativada). Você pode adicionar parâmetros (dependendo da configuração do site) para excluir permanentemente, se suportado.

Autenticação e Considerações de Segurança ao Usar a API do WordPress

Dados públicos (por exemplo, posts publicados) geralmente podem ser buscados sem autenticação.
Para criar, atualizar ou excluir conteúdo, você normalmente precisa de autenticação — via cookies de login do WordPress, Senhas de Aplicativo (disponíveis desde o WP 5.6) ou sistemas baseados em OAuth/token.
Sempre use HTTPS em produção para proteger credenciais e dados em trânsito.

Testando Endpoints da API do WordPress (Navegador ou Apidog)

Você pode testar endpoints com a mesma facilidade usando um navegador ou uma ferramenta de teste de API como o Apidog.

Usando o Navegador:

Cole a URL (por exemplo, .../wp-json/wp/v2/posts) na barra de endereço do navegador.
O navegador mostrará o JSON bruto — para torná-lo legível, instale uma extensão formatadora de JSON (por exemplo, JSON Formatter para Chrome, Firefox).

Usando o Apidog:

Crie um novo endpoint de API no Apidog.
Insira a URL (por exemplo, /wp-json/wp/v2/posts).
Escolha o método HTTP (GET, POST, PUT, DELETE).
Adicione cabeçalhos se necessário (para autenticação).

adicionar cabeçalhos personalizados no apidog para autenticação

Envie a requisição e inspecione a resposta JSON — o Apidog mostra o JSON estruturado, erros, cabeçalhos de resposta e facilita a depuração em comparação com as saídas brutas do navegador.

testando endpoints da api do wordpress com apidog

Este método é especialmente útil para requisições POST/PUT/DELETE — onde o navegador sozinho não oferece uma maneira fácil de enviar corpos de requisição JSON ou cabeçalhos personalizados.

Melhores Práticas e Dicas para Desenvolvedores Usando a API do WordPress

Use _fields ou parâmetros de paginação para limitar o tamanho da carga útil ao recuperar muitos dados.
Autentique-se com segurança usando Senhas de Aplicativo ou OAuth para operações de escrita.
Verifique as configurações de permalinks do site — certifique-se de que os permalinks bonitos ou as rotas REST de fallback estejam funcionando (wp-json/).
Gerencie permissões — apenas usuários com funções apropriadas podem criar ou excluir conteúdo.
Limite de taxa e tratamento de erros — trate as falhas da API com elegância e respeite os recursos do servidor.
Use ferramentas de formatação JSON ao testar em um navegador para legibilidade ou depuração.

Perguntas Frequentes (FAQ)

Q1. Eu sempre preciso de uma chave de API para usar a API do WordPress?
Não — para dados públicos como posts publicados ou páginas públicas, você pode usar requisições GET sem autenticação. No entanto, para criar, editar ou excluir conteúdo, geralmente você precisa de credenciais adequadas. (Para mais detalhes sobre este assunto, confira WPZOOM)

Q2. Qual é a diferença entre os endpoints wp-json/wp/v2/ e public-api.wordpress.com?
wp-json/wp/v2/ é usado por sites WordPress auto-hospedados (WordPress.org). A estrutura public-api.wordpress.com/... é usada por sites hospedados no WordPress.com — a URL base e os namespaces diferem, mas o conceito da API REST permanece semelhante. (Veja mais exemplos em Sistema de Conteúdo Noroff FEU)

Q3. Posso criar endpoints personalizados ou expor tipos de posts personalizados na API?
Sim. Por padrão, os tipos de posts principais (posts, páginas, mídia, comentários, etc.) são expostos. Para tipos de posts personalizados ou campos personalizados (metadados), você pode precisar registrar suporte REST em seu tema ou plugin (por exemplo, usando register_post_type(..., 'show_in_rest' => true)).

Q4. Como posso testar endpoints de API sem escrever código?
Você pode usar um navegador (para requisições GET) — basta navegar até a URL do endpoint. Para POST/PUT/DELETE (ou operações que exigem autenticação), use uma ferramenta cliente de API como o Apidog. Ele permite enviar corpos JSON, definir cabeçalhos e inspecionar respostas convenientemente.

Q5. É seguro expor dados de usuário ou comentários via API?
Se o seu site permite acesso público a certos recursos (como posts ou comentários visíveis publicamente), então sim — a API retorna apenas o que é permitido. Para dados privados ou operações autenticadas, garanta que a autenticação e as permissões adequadas estejam em vigor.

Conclusão

A API do WordPress transforma seu site WordPress em um backend programável — permitindo que você leia, crie, atualize e exclua conteúdo via chamadas HTTP padrão. Seja você construindo um frontend CMS headless, um aplicativo móvel ou automatizando fluxos de trabalho de conteúdo, a API REST oferece uma interface robusta e flexível.

Ao entender a estrutura de URL, os endpoints principais, a semântica CRUD, a autenticação e a metodologia de teste (via navegador ou Apidog), você pode integrar o WordPress com praticamente qualquer sistema externo. Com boas práticas de API — autenticação segura, consultas eficientes e tratamento adequado — o WordPress se torna mais do que uma plataforma de blog — ele se torna um backend de conteúdo completo.

💡

button