Referência da REST API
Este texto foi traduzido usando IA. Se você quiser ver o texto original em inglês, clique aqui.
Bem-vindo à página de referência da REST API do WordPress.com. Esta página lista uma seleção de endpoints disponíveis, cada um com link para uma página completa detalhando a entrada, a saída e exemplos de código em curl e PHP.
Alternativamente, o Console de Desenvolvimento oferece uma visão completa de todos os endpoints disponíveis, agrupados por namespace e versão. Embora não forneça detalhes aprofundados para cada endpoint, ele permite que você construa e teste requisições reais à API para cada endpoint de forma interativa.
Ao fazer requisições à API, você precisará usar o formato padronizado de URL da REST API do WordPress.com: https://public-api.wordpress.com/{namespace}/{version}/sites/{site_id}/{endpoint}.
Para informações detalhadas sobre estruturas de URL, obtenção do ID do seu site e boas práticas para fazer requisições à API, consulte o Guia de Introdução.
Para mais informações sobre um endpoint específico, clique no nome dele sob o cabeçalho Recurso. Você será direcionado à página de documentação do endpoint, que inclui quais parâmetros de consulta o endpoint aceita, quais serão os parâmetros do objeto JSON na resposta e um exemplo de consulta/resposta.
Usuários
Visualize dados de informações do usuário, como nome de usuário, nome, e-mail, blog e Gravatar.
| Recurso | Descrição |
|---|---|
| GET/sites/$site/users | Listar os usuários de um site. |
| POST/sites/$site/users/$user_id | Atualizar detalhes de um usuário de um site. |
| POST/sites/$site/invites/new | Convidar um ou mais usuários para o seu site. |
| GET/sites/$site/users/login:$user_id | Obter detalhes de um usuário de um site pelo login. |
| POST/sites/$site/users/$user_ID/delete | Excluir ou remover um usuário de um site. |
| GET/users/suggest | Obter uma lista de possíveis usuários para sugerir em @menções. |
| GET/me | Obter metadados sobre o usuário atual. |
| GET/me/billing-history | Obter a lista do histórico de cobranças e cobranças futuras do usuário atual. |
| GET/me/settings/ | Obter as configurações do usuário atual. |
| POST/me/settings/ | Atualizar as configurações do usuário atual. |
| GET/me/preferences/ | Obter as configurações do usuário atual. |
| POST/me/preferences/ | Atualizar as preferências do usuário atual. |
| POST/me/settings/password/validate | Verificar a força de uma nova senha do usuário. |
| GET/me/settings/profile-links/ | Obter os links do perfil do usuário atual. |
| POST/me/settings/profile-links/new | Adicionar um link ao perfil do usuário atual. |
| POST/me/settings/profile-links/$slug/delete | Excluir um link do perfil do usuário atual. |
| GET/me/connected-applications/ | Obter os aplicativos conectados do usuário atual. |
| GET/me/connected-applications/$ID | Obter um dos aplicativos conectados do usuário atual. |
| POST/me/connected-applications/$ID/delete | Excluir um dos tokens de acesso de aplicativos conectados do usuário atual. |
| GET/me/two-step | Obter informações sobre a configuração de autenticação em dois fatores do usuário atual. |
| POST/me/two-step/sms/new | Enviar um código de verificação em dois fatores via SMS para o usuário atual. |
| GET/me/likes/ | Obter uma lista de curtidas do usuário atual. |
Sites
Visualize informações gerais e opções do site.
| Recurso | Descrição |
|---|---|
| GET/sites/$site/shortcodes/render | Obter um shortcode renderizado para um site. Observação: o usuário atual deve ter acesso de publicação. |
| GET/sites/$site/shortcodes | Obter uma lista de shortcodes disponíveis em um site. Observação: o usuário atual deve ter acesso de publicação. |
| GET/sites/$site/embeds/render | Obter um embed renderizado para um site. Observação: o usuário atual deve ter acesso de publicação. |
| GET/sites/$site/embeds | Obter uma lista de embeds disponíveis em um site. Observação: o usuário atual deve ter acesso de publicação. |
| GET/sites/$site | Obter informações sobre um site. |
| GET/sites/$site/page-templates | Obter uma lista de modelos de página compatíveis com um site. |
| GET/sites/$site/post-types | Obter uma lista de tipos de post disponíveis para um site. |
| GET/sites/$site/post-counts/$post_type | Obter o número de posts nos grupos de tipo de post por status do post |
| GET/sites/$site/widgets | Recuperar os widgets ativos e inativos de um site. |
| POST/sites/$site/widgets/new | Ativar um widget em um site. |
| GET/sites/$site/wordads/settings | Obter informações detalhadas das configurações do WordAds de um site. |
| POST/sites/$site/wordads/settings | Atualizar as configurações do WordAds de um site. |
| GET/sites/$site/wordads/earnings | Obter informações detalhadas dos ganhos do WordAds de um site. |
| GET/sites/$site/wordads/tos | Obter informações dos Termos de Serviço do WordAds de um site. |
| POST/sites/$site/wordads/tos | Atualizar a configuração dos Termos de Serviço do WordAds de um site. |
| POST/sites/$site/wordads/approve | Solicitar aprovação simplificada para participar do programa WordAds. |
| GET/sites/$site/wordads/stats | Obter estatísticas do WordAds de um site |
| GET/me/sites | Obter uma lista dos sites do usuário atual. |
| GET/me/sites/features | Obter uma lista dos recursos dos sites do usuário atual |
| GET/me/sites/plugins | Obter uma lista dos plugins dos sites do usuário atual |
| POST/sites/$site/search | Pesquisar dentro de um site usando a API de consulta do Elasticsearch. |
| GET/sites/$site/widgets/widget:$id | Recuperar um widget de um site pelo seu ID. |
| POST/sites/$site/widgets/widget:$id | Atualizar um widget de um site pelo seu ID. |
| POST/sites/$site/widgets/widget:$id/delete | Desativar um widget de um site pelo seu ID. Será excluído se já estiver desativado. |
| GET/sites/$site/headers/$theme_slug | Obter as opções de cabeçalho personalizado de um site com um tema específico. |
| GET/sites/$site/headers/mine | Obter as opções de cabeçalho personalizado de um site. |
| POST/sites/$site/headers/mine | Definir as opções de cabeçalho personalizado de um site. |
Posts
Visualize e gerencie posts, incluindo reblogs e curtidas.
| Recurso | Descrição |
|---|---|
| GET/sites/$site/dropdown-pages/ | Obter uma lista de páginas para exibição como opções em um menu suspenso de seleção de página. |
| GET/sites/$site/posts/$post_ID | Obter um post único (por ID). |
| POST/sites/$site/posts/$post_ID | Editar um post. |
| GET/sites/$site/posts/slug:$post_slug | Obter um post único (por slug). |
| GET/sites/$site/posts/ | Obter uma lista de posts correspondentes. |
| POST/sites/$site/posts/new | Criar um post. |
| POST/sites/$site/posts/$post_ID/delete | Excluir um post. Observação: se a lixeira estiver habilitada, esta solicitação enviará o post para a lixeira. Uma segunda solicitação excluirá permanentemente o post. |
| POST/sites/$site/posts/$post_ID/restore | Restaurar um post ou página da lixeira para o status anterior. |
| POST/sites/$site/posts/delete | Excluir vários posts. Observação: se a lixeira estiver habilitada, esta solicitação enviará os posts não descartados para a lixeira. Posts na lixeira serão excluídos permanentemente. |
| POST/sites/$site/posts/restore | Restaurar vários posts. |
| GET/me/posts | Obter uma lista de posts de todos os sites do usuário. |
| GET/sites/$site/posts/$post_ID/likes/ | Obter uma lista de curtidas de um post. |
| POST/sites/$site/posts/$post_ID/likes/new | Curtir um post. |
| POST/sites/$site/posts/$post_ID/likes/mine/delete | Descurtir um post. |
| GET/sites/$site/posts/$post_ID/likes/mine/ | Obter o status de curtida do usuário atual para um post. |
| GET/sites/$site/posts/$post/subscribers/ | Obter uma lista de assinantes do post especificado. |
| GET/sites/$site/posts/$post/subscribers/mine | Obter o status de assinatura do post especificado para o usuário atual. |
| POST/sites/$site/posts/$post/subscribers/new | Inscrever o usuário atual para receber notificações dos comentários do post especificado. |
| POST/sites/$site/posts/$post/subscribers/mine/update | Inscrever o usuário atual para receber notificações dos comentários do post especificado. |
| POST/sites/$site/posts/$post/subscribers/mine/delete | Cancelar a inscrição do usuário atual no post especificado. |
| POST/sites/$site/posts/$post_ID/reblogs/new | Fazer Reblog de um post. |
| GET/sites/$site/posts/$post_ID/reblogs/mine | Obter o status de Reblog de um post. |
| POST/sites/$site/posts/$post/related | Pesquisar posts relacionados dentro de um site. |
Comentários
Visualize e gerencie os comentários de um post.
Taxonomia
Visualize e gerencie as tags e categorias de um site.
Seguir
Seguir e deixar de seguir blogs.
| Recurso | Descrição |
|---|---|
| GET/sites/$site/follows/ | Listar os seguidores de um site em ordem cronológica inversa. |
| POST/sites/$site/follows/new | Seguir um blog. |
| POST/sites/$site/follows/mine/delete | Deixar de seguir um blog. |
| GET/sites/$site/follows/mine | Obter o status de acompanhamento do blog para o usuário atual. |
Compartilhamento
Conecte serviços de mídia social para compartilhar automaticamente novos posts e gerencie os botões de compartilhamento em um site.
| Recurso | Descrição |
|---|---|
| GET/sites/$site/sharing-buttons/ | Obter uma lista dos botões de compartilhamento de um site. |
| POST/sites/$site/sharing-buttons | Editar todos os botões de compartilhamento de um site. |
| GET/meta/external-services/ | Obter uma lista de serviços de terceiros com os quais sites WordPress.com ou Jetpack podem se integrar via keyring. |
| GET/meta/external-services/$service | Obter informações sobre um único serviço externo com o qual sites WordPress.com ou Jetpack podem se integrar via keyring. |
| GET/me/publicize-connections/ | Obter uma lista de conexões de divulgação que o usuário atual configurou. |
| GET/me/publicize-connections/$publicize_connection_ID | Obter uma única conexão de divulgação que o usuário atual configurou. |
| POST/me/publicize-connections/$publicize_connection_ID | Atualizar uma única conexão de divulgação pertencente ao usuário atual. |
| POST/me/publicize-connections/$publicize_connection_ID/delete | Excluir a conexão de divulgação especificada. |
| GET/me/keyring-connections/ | Obter uma lista de todas as conexões de keyring associadas ao usuário atual. |
| GET/me/keyring-connections/$keyring_connection_ID | Obter uma única conexão de Keyring que o usuário atual configurou. |
| POST/me/keyring-connections/$keyring_connection_ID/delete | Excluir a conexão de Keyring (e o token associado) com o ID fornecido. Também exclui todas as conexões de divulgação associadas. |
| GET/sites/$site/publicize-connections/ | Obter uma lista de conexões de divulgação associadas ao site especificado. |
| GET/sites/$site/publicize-connections/$publicize_connection_ID | Obter uma única conexão de divulgação associada ao site especificado. |
| POST/sites/$site/publicize-connections/$publicize_connection_ID | Atualizar uma única conexão de divulgação pertencente ao site especificado. |
| POST/sites/$site/publicize-connections/new | Criar uma nova conexão de divulgação associada ao site especificado. |
| POST/sites/$site/publicize-connections/$publicize_connection_ID/delete | Excluir a conexão de divulgação especificada. |
| GET/meta/sharing-buttons | Obter uma lista de serviços externos para os quais botões de compartilhamento são suportados. |
Recém-publicados
Veja posts Recém-publicados da página inicial do WordPress.com.
| Recurso | Descrição |
|---|---|
| GET/freshly-pressed/ | Obter uma lista de posts Recém-publicados. (Nota: Recém-publicados foi descontinuado. Visite https://discover.wordpress.com para obter o melhor conteúdo publicado em nossa rede.) |
Notificações
Visualize e gerencie as notificações de um usuário.
| Recurso | Descrição |
|---|---|
| POST/notifications/seen | Define o timestamp da notificação visualizada mais recentemente. |
| POST/notifications/read | Marca um conjunto de notificações como lidas. |
Informações
Visualize as análises do seu aplicativo.
| Recurso | Descrição |
|---|---|
| GET/insights | Obtém uma lista de estatísticas/métricas/informações às quais o usuário atual tem acesso. |
| GET/insights/$slug | Obtém dados brutos de um gráfico específico. |
Leitor
Gerencie e visualize as assinaturas de um usuário no Leitor do WordPress.com.
| Recurso | Descrição |
|---|---|
| GET/read/menu/ | Obtém o menu padrão do leitor. |
| GET/read/feed/$feed_url_or_id | Obtém detalhes sobre um feed. |
| GET/read/sites/$site/posts/$post_ID | Obtém um post único (por ID). |
| GET/read/following/ | Obtém uma lista de posts dos blogs que um usuário segue. |
| GET/read/liked/ | Obtém uma lista de posts dos blogs que um usuário curtiu. |
| GET/read/tags/$tag/posts | Obtém uma lista de posts de uma tag. |
| GET/read/tags | Obtém uma lista de tags assinadas pelo usuário. |
| GET/read/tags/alphabetic | Obtém uma lista filtrada das principais tags, agrupadas por letra. |
| GET/read/trending/tags | Obtém uma lista de tags em alta. |
| GET/read/tags/$tag | Obtém detalhes sobre uma tag específica. |
| GET/read/tags/$tag/mine | Obtém o status de assinatura do usuário em uma determinada tag. |
| POST/read/tags/$tag/mine/new | Assina uma nova tag. |
| POST/read/tags/$tag/mine/delete | Cancela a assinatura de uma tag. |
| GET/read/following/mine | Obtém uma lista dos feeds que o usuário está seguindo. |
| POST/read/following/mine/new | Segue o blog especificado. |
| POST/read/following/mine/delete | Deixa de seguir o blog especificado. |
| GET/read/feed/ | Obtém o ID e a URL de assinatura de um ou mais feeds correspondentes por domínio ou URL. |
| GET/read/email-settings/ | Retorna as configurações de e-mail. |
| POST/read/email-settings/ | Retorna as configurações de e-mail. |
| GET/read/subscriptions-count/ | Retorna o número de assinaturas de blogs, comentários e assinaturas pendentes. |
| GET/read/recommendations/mine/ | Obtém uma lista de recomendações de blogs para o usuário atual. |
Estatísticas
Visualizar estatísticas de um site.
| Recurso | Descrição |
|---|---|
| GET/sites/$site/stats/highlights | Visualizar métricas de destaque dos últimos sete dias. |
| GET/sites/$site/stats | Obter as estatísticas de um site |
| GET/sites/$site/stats/summary | Visualizar o resumo de visualizações, visitantes, curtidas e comentários de um site |
| GET/sites/$site/stats/top-posts | Visualizar os posts e páginas mais visualizados de um site |
| GET/sites/$site/stats/video/$post_id | Visualizar os detalhes de um único vídeo |
| GET/sites/$site/stats/referrers | Visualizar os referenciadores de um site |
| GET/sites/$site/stats/clicks | Visualizar os cliques de saída de um site |
| GET/sites/$site/stats/tags | Visualizar as visualizações de um site por tags e categorias |
| GET/sites/$site/stats/top-authors | Visualizar os principais autores de um site |
| GET/sites/$site/stats/comments | Visualizar os principais autores de comentários e os posts mais comentados de um site |
| GET/sites/$site/stats/video-plays | Visualizar as reproduções de vídeo de um site |
| GET/sites/$site/stats/file-downloads | Visualizar os downloads de arquivos de um site |
| GET/sites/$site/stats/post/$post_id | Visualizar as visualizações de um post |
| GET/sites/$site/stats/country-views | Visualizar as visualizações de um site por país |
| GET/sites/$site/stats/followers | Visualizar os seguidores de um site |
| GET/sites/$site/stats/comment-followers | Visualizar os seguidores de comentários de um site |
| POST/sites/$site/stats/referrers/spam/new | Denunciar um referenciador como spam |
| POST/sites/$site/stats/referrers/spam/delete | Remover a denúncia de spam de um referenciador |
| GET/sites/$site/stats/publicize | Visualizar a contagem de seguidores de publicize de um site |
| GET/sites/$site/stats/search-terms | Visualizar os termos de pesquisa usados para encontrar o site |
| GET/sites/$site/stats/views/posts | Visualizar o número total de visualizações de cada post. |
| GET/sites/$site/stats/emails/summary | Visualizar o número total de aberturas e cliques de e-mail de cada post. |
| GET/sites/$site/stats/opens/emails/summary | Visualizar o número total de aberturas de e-mail de cada post. |
| GET/sites/$site/stats/opens/emails/$post_id | Visualizar múltiplas estatísticas relacionadas a aberturas de e-mail por post. |
| GET/sites/$site/stats/opens/emails/$post_id/client | Visualizar estatísticas de aberturas de e-mail por cliente. |
| GET/sites/$site/stats/opens/emails/$post_id/country | Visualizar estatísticas de aberturas de e-mail por país. |
| GET/sites/$site/stats/opens/emails/$post_id/device | Visualizar estatísticas de aberturas de e-mail por dispositivo. |
| GET/sites/$site/stats/opens/emails/$post_id/rate | Visualizar a taxa de aberturas de e-mail por post. |
| GET/sites/$site/stats/clicks/emails/$post_id | Visualizar estatísticas de gráfico relacionadas a cliques de e-mail por período. |
| GET/sites/$site/stats/clicks/emails/$post_id/rate | Visualizar a taxa de cliques de e-mail por post. Retorna dados simulados. |
| GET/sites/$site/stats/clicks/emails/$post_id/country | Visualizar cliques de e-mail por país. |
| GET/sites/$site/stats/clicks/emails/$post_id/device | Visualizar cliques de e-mail por dispositivo. |
| GET/sites/$site/stats/clicks/emails/$post_id/client | Visualizar cliques de e-mail por cliente. |
| GET/sites/$site/stats/clicks/emails/$post_id/link | Visualizar cliques de e-mail por link. |
| GET/sites/$site/stats/clicks/emails/$post_id/user-content-link | Visualizar cliques de e-mail por link de conteúdo do usuário. |
| GET/sites/$site/stats/clicks/emails/summary | Visualizar o número total de cliques de e-mail de cada post. |
| GET/sites/$site/stats/utm/$utm_param_name | Obter estatísticas de parâmetros UTM do site. |
| GET/sites/$site/stats/utm/$utm_param_name/top_posts | Obter os posts mais acessados para um determinado valor de parâmetro UTM. |
| GET/sites/$site/stats/streak | Obter estatísticas para o Mapa de Calor do Calendário. Retorna dados com o timestamp de cada post. |
Mídia
Gerenciar a biblioteca de mídia de um site.
| Recurso | Descrição |
|---|---|
| POST/sites/$site/media/$media_ID/delete | Excluir um item de mídia. Observação: a mídia é excluída e não enviada para a lixeira. |
| GET/sites/$site/media/$media_ID | Obter um único item de mídia (por ID). |
| POST/sites/$site/media/$media_ID | Editar informações básicas sobre um item de mídia. |
| GET/sites/$site/media/ | Obter uma lista de itens na biblioteca de mídia. |
| POST/sites/$site/media/new | Fazer upload de um novo item de mídia. |
| POST/sites/$site/media/$media_ID/edit | Editar um item de mídia. |
Menus
Visualizar e gerenciar os menus de um site.
| Recurso | Descrição |
|---|---|
| POST/sites/$site/menus/new | Criar um novo menu de navegação. |
| POST/sites/$site/menus/$menu_id | Atualizar um menu de navegação. |
| GET/sites/$site/menus/$menu_id | Obter um único menu de navegação. |
| GET/sites/$site/menus | Obter uma lista de todos os menus de navegação. |
| POST/sites/$site/menus/$menu_id/delete | Excluir um menu de navegação |
Batch
Agrupar várias requisições GET da API em uma só.
| Recurso | Descrição |
|---|---|
| GET/batch/ | Executa vários endpoints GET e os retorna como um array. |
Vídeos
Visualize informações de vídeo.
| Recurso | Descrição |
|---|---|
| GET/videos/$guid | Obtém os metadados de um vídeo VideoPress especificado. |
| GET/videos/$guid/poster | Obtém o poster de um vídeo VideoPress especificado. |
| POST/videos/$guid/poster | Faz upload e define um poster para um vídeo VideoPress especificado. |
| GET/videos/$guid/chapters | Obtém os capítulos de um vídeo VideoPress especificado. |
| GET/videos/$guid/playlist/$format | Obtém o poster de um vídeo VideoPress especificado. |
| POST/videos/$guid/tracks | Faz upload de uma faixa de legenda/subtítulo para um vídeo VideoPress especificado. |
| POST/videos/$guid/tracks/delete | Exclui uma faixa de legenda/subtítulo existente de um vídeo VideoPress especificado. |
Agências
Gerencie sites e ferramentas de agência.
| Recurso | Descrição |
|---|---|
| GET /wpcom/v2/agency/$agency_id/sites | Obtém uma lista de sites gerenciados pela agência. |
| GET/wpcom/v2/agency/$agency_id/sites/pending | Obtém uma lista de sites disponíveis para provisionamento. |
| POST/wpcom/v2/agency/$agency_id/sites/$site_id/provision | Provisionamento de um novo site para a agência. |
| GET/wpcom/v2/sites/$wpcom_site/staging-site | Recupera o site de teste associado a um site de produção especificado. |
| POST/wpcom/v2/sites/$wpcom_site/staging-site | Cria um site de teste para um site existente. |
| DELETE/wpcom/v2/sites/$wpcom_site/staging-site/$staging_site_id | Exclui o site de teste associado ao site de produção especificado. |
| GET/sites/$site/automated-transfers/status | Retorna o status atual da Transferência Automatizada de um site. |
GitHub Deployments
Faça deploy de código na infraestrutura do WordPress.com.
| Recurso | Descrição |
|---|---|
| GET/hosting/github/installations | Retorna uma lista de instalações às quais um usuário do GitHub tem acesso por meio de instalações de aplicativos. |
| GET/hosting/github/repositories | Obtém uma lista de repositórios e seus external_repository_ids. |
| GET/sites/$wpcom_site/hosting/code-deployments | Obtém uma lista de deploys de código configurados para este site. |
| POST/sites/$wpcom_site/hosting/code-deployments | Cria ou atualiza uma configuração de deploy para este site. |
| DELETE/wpcom/v2/sites/$wpcom_site/hosting/code-deployments/$deployment_id | Exclui uma configuração de deploy de um site. |
| GET/wpcom/v2/sites/$wpcom_site/hosting/code-deployments/$deployment_id/runs | Obtém as execuções de deploy de código. |
| POST/sites/$wpcom_site/hosting/code-deployments/$deployment_id/runs | Inicia uma execução manual de deploy de código usando seu deployment_id. |
| GET/sites/$wpcom_site/hosting/code-deployments/$deployment_id/ runs/$deployment_run_id/logs | Obtém os logs de uma execução de deploy de código usando seu deployment_id e deployment_run_id. |
Gerenciamento de SSH
Crie e gerencie o acesso SSH aos servidores do WordPress.com.
| Recurso | Descrição |
|---|---|
| GET/wpcom/v2/sites/$wpcom_site/hosting/ssh-users | Obtém os usuários SSH de um site. |
| POST/wpcom/v2/sites/$wpcom_site/hosting/ssh-user | Cria um usuário SSH para um site. |
| POST/wpcom/v2/sites/$wpcom_site/hosting/ssh-user/$ssh_user/reset-password | Rotaciona a senha do usuário SSH e a retorna. |
| GET/wpcom/v2/sites/$wpcom_site/hosting/ssh-access | Obtém o tipo de configuração de acesso SSH de um site. |
| POST/wpcom/v2/sites/$wpcom_site/hosting/ssh-access | Define a configuração de acesso SSH de um site. |
| GET/wpcom/v2/sites/$wpcom_site/hosting/ssh-keys | Obtém as chaves SSH de um site. |
| POST/wpcom/v2/sites/$wpcom_site/hosting/ssh-keys | Vincula uma nova chave SSH a um site. |
| DELETE/wpcom/v2/sites/$wpcom_site/hosting/ssh-keys/$user_name/$name | Desvincula uma chave SSH de um site. |
Última atualização: junho 18, 2026
Recursos para desenvolvedores do WordPress.com