Guia do iniciante para API REST do WordPress
Praticamente todo profissional que já trabalhou com WordPress, já ouviu falar do REST API, graças a sua adição de núcleo no final de 2015. No entanto, na maioria das vezes apenas os desenvolvedores mais experientes aproveitam o tempo para aprender o quão poderoso esse novo recurso pode ser.
O REST API do WordPress contém um wallop em toda instalação de atualização, provendo um API que pode ser integrado em temas, aplicações móveis, e mais. Ele possibilita desenvolvedores separar a interface frontal da gestão de dados, permitindo qualquer interação com o WordPress. Aprendendo como utilizar essa ferramenta, ela pode abrir portas para incontáveis possibilidades no seu site ou na sua hospedagem WordPress rápida.
Neste artigo, vamos introduzir você ao projeto REST API, e mostrar o porque é um grande negócio, em seguida, oferecer algumas dicas sobre como usá-lo. Vamos começar.
Conteúdo
Introdução ao REST API WordPress
O Projeto WordPress Representational State Transfer (REST) API afirma que está fazendo movimentos para se tornar um aplicativo de estrutura de aplicação completa, sua própria existência suporta essa reivindicação, pois acrescenta uma REST API padrão, no núcleo do WordPress.
O projeto foi enviado pela primeira vez ao Github para desenvolvimento em junho de 2013 por Ryan McCue e Rachel Baker. O plugin independente REST API que foi integrado ao núcleo do WordPress em dezembro de 2015, após ter ganho muito suporte público e acabou atraindo mais de 100 colaboradores para trabalhar no refinamento de suas habilidades.
Desde a sua estréia no WordPress, o REST API provou ter muitas utilidades, aqui estão apenas algumas maneiras de como aproveitá-lo em seus projetos, inspirados em exemplos do mundo real:
- O Event Espresso usá uma REST API para fornecer o acesso do desenvolvedor à sua infra-estrutura, possibilitando o desenvolvimento de aplicativos com base em seus serviços
- O simmer permite aos desenvolvedores acessar a API para ampliar sua funcionalidade de receita em aplicativos móveis em pleno direito ou temas personalizados.
- JoinIn potencializa seu próprio widget “incorporáveis” usando a REST API, preenchendo-o com dados apropriados, onde quer que seja exibido.
Esta é apenas a ponta do iceberg quando se trata de usos inovadores para REST API. No entanto, vamos agora discutir como funciona a REST API.
Como REST API do WordPress funciona?
Em suma, a REST API funciona manipulando dados textuais de algum lugar para outro sem acesso direto a um banco de dados ou interface do usuário. Existem muitos tipos de interfaces de Programação de aplicativos (API’s), embora o REST se destaca como um padrão moderno.
REST API’s são distribuídas através das extremidades do HTTP (HyperText Transfer Protocol)
Utilizando javaScript Object Notation (JSON) para formatação, em termos simples, essas tecnologias proveem acesso a API usando um endereço web único para enviar dados que se comportam como Objetos JavaScript.
Se você nunca trabalhou com JavaScript ou notação de objetos antes, seria uma boa ideia começar aprendendo os conceitos Básicos de JSON. Uma vez que você estiver confortável com o conceito de uma REST API, vamos falar mais sobre o grande impacto que terá sobre os desenvolvedores do WordPress.
Por que o REST API WordPress é importante para Desenvolvedores?
A REST API do WordPress é um conector universal de qualquer instalação do WordPress para qualquer aplicativo especificado em um servidor web ou sistema operacional do usuário. Em última análise, isso significa que o único limite para o que pode ser criado usando o WordPress agora é nossa única e própria imaginação.
Você pode criar qualquer aplicativo, codificar com qualquer plataforma ou idioma, e usar o WordPress para lidar com os dados através da REST API. As implicações disso são enormes, graças ao WordPress e sua comunidade aberta e amigável.
Além disso, uma vez que a REST API é baseada em JavaScript, esse foco crescente na API, marca uma mudança na qual às linguagens de programação são mais importantes para aprender. Você pode achar que o JavaScript do lado do servidor é o novo PHP. isso pode ser visto no novo Software WordPress.com, Calypso, que é executado completamente em JavaScript e na REST API.
Ao padronizar a plataforma com os aplicativos, incluindo o núcleo do WordPress, interagem com os dados do WordPress, o Desenvolvimento do WordPress se tornará mais simples e intuitivo, além disso, será mais fácil integrar com plataformas de terceiros.
No entanto, o período de transição pode ser um pouco difícil e por isso que é importante começar a aprender a usar essa tecnologia agora. É hora de usar os primeiros passos para o uso da REST API em seu próprio trabalho.
5 Passos para começar a trabalhar com o WordPress REST API
Conforme abordamos anteriormente, o REST API pode ser usada com qualquer aplicativo ou linguagem de programação que possa chamar uma extremidade do HTTP, o que é a maioria delas. Portanto nós concentramos no uso da linha de comando para executar os pedidos da REST API, porque esse é o método mais simples e tem o menor número possível de erros programáticos para interromper sua aprendizagem.
Para fazer isso, você deseja abrir o programa dá interface de linha de comando (CLI) no seu computador. Terminal no MacOS e linux e Prompt Comando no windows. A CLI permite que interaja diretamente com a REST API sem precisar escrever scripts adicionais para solicitar e processar a informação.
Qualquer pedido que você fizer na CLI pode ser roteado para PHP, JavaScript e outros idiomas, mas o método variará para cada um. Dar comandos na CLI é fácil, basta digitar o comando desejado e pressionar ENTER no seu teclado.
Também recomendamos configurar um site demo para testar localmente, em vez de concluir esse tutorial em um site ao vivo. Finalmente. O único requisito é que seu site WordPress esteja sendo executado na versão 4.4 ou superior, quando estiver pronto, vamos começar.
Etapa 1: Familiarize-se com os conceitos-chave da REST API
Antes de começar, é uma ideia inteligente se familiarizar com todas as partes móveis dá REST API. existem cinco conceitos e termos principais com os quais você deve estar familiarizado. Vamos examiná-los agora:
- “Vias”/”rotas” e “Extremidades”/”pontos finais”: este é o aspecto mais importante dá REST API para entender. Os roteiros ajudam você a navegar através dos pontos finais que é quando um método HTTP específico, por exemplo, um conjunto de dados estático ou uma ação, é conectada a uma rota específica. Por exemplo /wp-json/ é uma rota configurada como um ponto final, projetado para nos mostrar rotas disponíveis.
- Solicitações: Esses são feitos quando desencadeado os pontos de extremidade corretos e transmitindo dados.
- Respostas: Em suma, isso fornece os dados que você solicitou ou retorna um erro para que você saiba que algo errado aconteceu.
- Esquemas: Essas são as respostas dos modelos, então você sempre sabe exatamente onde procurar os dados certos.
- Classes de controles: Em termos leigos, eles permitem que você crie suas próprias rotas e Extremidades. Por enquanto você não precisa se preocupar com isso, no entanto eles ficarão mais e mais úteis conforme o tempo.
Depois de entendido esses cinco conceitos, você pode já começar a se aprofundar a própria REST API começando pelos seus EndPoints.
Passo 2: Conheça o EndPoint mais úteis a REST API
O REST API do WordPress oferece um manual de referência carregado com todos os EndPoints que você achará mais eficiente, primeiro você quer saber como construir uma chamada HTTP para o REST API. A base de cada chamada do REST API do WordPress é a seguinte, substituindo o marcador de posição, yourdomain.com pelo seu próprio:
| 1 | http://yourdomain.com/wp-json/ |
Você pode testar sua conexão executando o comando curl em sua CLI usando seu próprio URL:
| 1 | curl -X OPTIONS -i http://yourdomain.com/wp-json/ |
Você deve ser recebido com uma mensagem HTTP de sucesso. Você pode então pode atualizar e repetir este comando usando vários dos principais pontos finais, dessa vez, simplesmente, usaremos a versão GET de curl.
Para pegar uma lista JSON de suas postagens do WordPress, você pode usar o seguinte:
| 1 | curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts |
Alternativamente, tente isso para verificar todas suas páginas existentes do WordPress:
| 1 | curl -X GET -i http://yourdomain.com/wp-json/wp/v2/pages |
Você pode experimentar com cada um desses EndPoints (e mais) na CLI para rever o tipo de resposta retornada para cada um.
Etapa 3: Aprenda o básico dá autenticação do REST API
Agora é hora de aprender sobre autenticação. Algumas ações e dados dentro dá REST API são públicos, enquanto outros exigem que você seja logado como administrador. No entanto essa é uma REST API, portanto, não há onde entrar, em vez disso você pode autenticar-se ao fazer qualquer chamada que exija acesso administrativo, como visualização de conteúdo não publicado ou atualização de uma publicação.
Comece instalando o plugin WordPress REST API Basic Auth. esse é um simples plugin de desenvolvedor a aprender rapidamente REST API, e não se destina a sites online. No entanto, o processo de instalação é como a de qualquer outro plugin.
Uma vez que o Basic Auth esteja instalado, você poderá autenticar sobre a CLI com sua user Flag. aqui está um exemplo de como aplicar o método de autenticação do usuário Curl para visualizar posts inéditos.
| 1 | curl -X GET –user username:password -i http://yourdomain.com/wp-json/wp/v2/posts?status=draft |
A autenticação será necessária para qualquer outra coisa além da exibição das informações públicas. Depois de obter o atraso da autenticação básica, você pode explorar as outras opções recomendadas pela documentação da REST API para seu código de produção.
Etapa 4: Selecione seu primeiro post do WordPress com a REST API
Depois de entender como fazer chamadas básicas para REST API utilizando o Curl, tente selecionar uma publicação específica. Primeiro, liste todas suas postagens, como fizemos anteriormente:
| 1 | curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts |
Em seguida, encontre a ID de uma publicação que deseja atualizar. Você adicionará essa ID ao final da sua consulta para selecionar apenas essa publicação individual:
| 1 | curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts/<ID> |
Você pode usar isso para selecionar uma ID específica para qualquer EndPoint do REST API que você queira visualizar algum post, página ou taxonomia.
Etapa 5: Atualize seu primeiro post WordPress com o REST API
Finalmente, vamos tentar enviar uma atualização para a publicação selecionada. Em vez de usar os comandos OPTION ou GET, dessa vez queremos POSTAR uma alteração. GET é usado para ler dados, enquanto, o POST é usado para enviá-lo.
Vamos nomear o título de sua postagem para outra coisa, enviando um pedido, POST junto com suas credenciais de atualização. Novas alterações serão compartilhadas usando o sinalizador D no final do seu comando. Você passará um objeto JavaScript personalizado configurado a variável de título para um valor personalizado, como Meu Novo Título para um valor personalizado, conforme visto no código de exemplo abaixo:
| 1 | curl -X POST –user username:password http://yourdomain.com/wp-json/wp/v2/posts/<ID> -d ‘{“title”:”My New Title”}’ |
Certifique-se de substituir o nome de usuário, senha, identificação postal e o nome do título pela própria informação. Você pode selecionar novamente a publicação individual para verificar as novas alterações..
| 1 | curl -X GET -i http://yourdomain.com/wp-json/wp/v2/posts/<ID> |
Parabéns! Você acabou de fazer suas primeiras edições administrativas usando o REST API do WordPress. Claro que este tutorial basico apenas arranha a superfície do que o REST API pode fazer, mas neste momento o céu o limite.
Conclusão
O REST API do WordPress é uma nova adição poderosa ao núcleo do WordPress, e poucos desenvolvedores começam a arranhar a superfície de suas capacidades. Como consequência ficar a bordo, e aprender a trabalhar com ele, pode ajudar a transformá-lo em algo mais valioso como desenvolvedor e permite que você crie aplicativos usando o WordPress como estrutura.
Para revisar, aqui estão os nossos cinco passos para aprender a interagir com o REST API do WordPress:
- Familiarize-se com os conceitos chave do REST API
- Conheça os pontos de extremidade do REST API mais úteis
- Saiba o básico dá autenticação do REST API
- Selecione sua primeira postagem do wordpress com um REST API.
- Atualize uma postagem do WordPress com o REST API.
E é isso! Sucesso!
A Ariane é SEO Team Leader com experiência em conteúdo, localização e SEO. Seu desafio é levar a Hostinger ao topo dos resultados no Brasil, França e Reino Unido. Eventualmente ela compartilha seu conhecimento no blog e nos tutoriais da Hostinger e no tempo livre ela gosta de explorar lugares novos e viver intencionalmente.
Comentários
maio 16 2018
Bom dia! Gostaria de saber se consigo construir um tema para WordPress utilizando da API, programando em outra linguagem por exemplo Python como back-end e React com JS no front.
maio 22 2018
Bom dia, Eduarda, Tudo bem? Primeiramente, você precisa ter uma VPS para usar o Python. Se você tem uma VPS conosco, dá pra fazer. Se no seu caso for uma hospedagem compartilhada, infelizemente não tem como. Basicamente, você precisa de permissão de admin na hospedagem para poder fazer isso. Se tiver mais alguma dúvida pode entrar em contato conosco. :D
junho 12 2018
Olá! Será que o Rest api pode ser a solução para localizar uma linha comando e fazer alterações?!? Ok, vou ser mais claro, estou tentando fazer uma alteração para mostrar a data da última atualização dos posts mas todas as pesquisas que fiz na internet apontam como solução alterar o código da single.php mas especificamente alterar o código "the_time". O grande problema é que esse comando não está na single.php provavelmente por conta do tema... Agora retomando, será que com o Rest Api não seria possível fazer essa alteração de forma mais simples?
junho 15 2018
Olá, Eder, tudo certo? Sim, é possível usar API REST pra mostrar a data da última alteração do post, mas tem um jeito mais simples de fazer o que você precisa. Essa função abaixo faz com que o WordPress identifique a última data em que o post foi atualizado e mostra na tela: `function wpb_last_updated_date( $content ) {` `$u_time = get_the_time('U');` `$u_modified_time = get_the_modified_time('U');` `if ($u_modified_time >= $u_time + 86400) {` `$updated_date = get_the_modified_time('F jS, Y');` `$updated_time = get_the_modified_time('h:i a');` `$custom_content .= '
Last updated on '. $updated_date . ' at '. $updated_time .'
';` `}` `$custom_content .= $content;` `return $custom_content;` `}` `add_filter( 'the_content', 'wpb_last_updated_date' );` Copiando estas linhas de código e colocar no fim do seu arquivo `functions.php` do tema que está em uso, assim que salvar pode recarregar a pagina do painel do WordPress que você provavelmente vai estar logado e assim que editar um post e salvar, ao acessar o post vai continuar mostrando a date me que ele foi postado e logo abaixo do título deve ser mostrado a data em que seu post foi alterado. Veja o resultado: http://prntscr.com/jvg48v :)"abril 18 2019
Obrigado pela dica Ariane! Acredito que deixei passar batido o email de alerta sobre sua resposta e por isso estou vendo agora, quase um ano depois, rs. Acabei voltando a esta página porque ela aparece como backlink para meu site.
abril 23 2019
Tenho uma VPS com API Rest em Spring. E gostaria que os dados da minha API fossem lido no lado do Wordpress. Ex: Relação de clientes ou produtos. Isso e possível ? como faria ? Como poderia criar formulários dinâmicos no Wordpress consumindo API ? Penso em criar formulários no lado do Wordpress para serem recebidos e/ou enviado via API para minha outra VPS.
abril 24 2019
Oi, Avelino Você pode entrar em contato com nossa equipe de sucesso do cliente através do seu painel de controle que vamos te ajudar :)
outubro 14 2020
Olá, tenho uma dúvida. Como posso transformar o resultado de uma consulta via API externa (formato de texto) em um produto a ser adicionado no carrinho? Existe algum plugin pra isso?
outubro 14 2020
Olá Matheus, não ouvimos falar de nada do tipo não, infelizmente. Acho que o processo tem que ser manual mesmo :(
novembro 16 2021
Ola! Pessoal, tenho um projeto de aplicação feito no Bubble, mas queria construir uma API para levar o mesmo usuário do banco de dados do Bubble para o banco de dados de usuários do WordPress. Alguém consegue me ajudar, me dar uma dia de como construir essa api ?
novembro 19 2021
Olá, vou ser sincero que não entendo muito de Bubble, mas você pode dar uma lida neste artigo aqui para ver se não ajuda! ?
junho 14 2022
Olá Pessoal! Eu consigo utilizar a API Rest para pegar informações de estoque em um arquivo .txt e atualizar o estoque de produtos do Woocommerce?
julho 01 2022
Olá, Will! Eu verifiquei com a nossa equipe técnica, e eles não sabem de nenhuma maneira de usar a API Rest do WordPress para recuperar um arquivo .txt. O mais próximo do que você está tentando fazer que eles acharam é esse tópico aqui no StackOverflow. Apesar disso, é possível usar a Rest API para obter informações de estoque no WooCommerce. Isso pode ser feito usando os métodos descritos aqui ?
outubro 11 2022
Olá Galera, Como vão, tudo bem? Tem uma loja Virtual com um Calendário. Preciso colocar esse calendário em uma landing page. Como poderia implementar com API REST no Wordpress. Onde o usuário clica na data do calendário e é redirecionado para a página da LOJA do Link acima com a data e marcado no calendário. Fico no aguardo das considerações! Abraços!
outubro 14 2022
Olá, Luiz Carlos! Vê se este texto sobre o Events Calendar REST API Reference não consegue te ajudar a implementar esse recurso! ?
fevereiro 06 2023
Ola tudo bem ? eu queria saber qual arquivo que tenho que fazer essa troca para o meu domínio poderia me ajudar?
fevereiro 10 2023
Olá, Guilherme! De que troca de domínio você estaria falando? Mas pode ser que você esteja falando do functions.php que mencionamos em outro comentário ?
abril 13 2023
Bom dia amigos, não entendo muito de WordPress woocomerce, fiz um aplicativo uma API que manda os produtos um por um para o ecommerce pois tentei de 100 em 100 mas me retorna erro pois o woocommerce so aceita de 100 em 100, tentei mudar mas nao achei, entao mando um por um, ai nao da o erro, mas demora 9hrs para subir os 7mil produtos com fotos - Agora tenho um problema serio preciso subir 70 mil produtos de uma outra empresa e ja tentei o json, mas retorna erro. podem me ajudar por favor como fazer subir os produtos, ou seja o json rapido.
abril 28 2023
Olá, Rubens! Conversei com nossa equipe técnica e eles explicaram que você não precisa usar uma API para importar produtos em massa. Como você já tentou o método JSON, recomendamos que você tente o método CSV. Ele pode ser feito usando este plugin gratuito, que também importa imagens de produtos ?
janeiro 13 2024
Olá! Tendo a integração com a API REST é possível conectar um banco de dados MySQL e efetuar consultas e requisições através da linguagem JAVA ?
janeiro 26 2024
Oi, Leonardo! É sim :)