O que é uma API e como usar APIs do WordPress

0

Se você não é um desenvolvedor web profissional, pode não ter muita ideia do que significa “API do WordPress”. O termo que você leu em um blog ou que ouviu em uma das conversas de trabalho ou apenas toma um drinque com os amigos da guilda.

Se este for o seu caso, não se preocupe, pois é algo normal e hoje nem todos sabem o que é e para que serve. Portanto, tentarei explicar, na linguagem e nos termos mais simples possíveis, o que é uma API e como a API do WordPress é usada . Pegue papel e caneta e vamos fazê-lo!

O que é uma API?

Falar tecnicamente sobre uma API é bastante complexo, mas o que não é complexo é saber o que é uma API em geral.

Uma API (Application Programming Interface) é um recurso de alguns serviços que permite aos programadores interagir com eles a partir de aplicativos externos . Em suma, é um conjunto de funções e procedimentos que permitem o acesso às funcionalidades de um software de outro externo a ele. Dessa forma, o código do aplicativo original é abstraído e você não precisa saber como o código funciona ou saber para usá-lo.

Por exemplo, o aplicativo do Twitter para Iphone ou Android faz chamadas para as APIs da rede social para obter os dados que o aplicativo deseja exibir. Seus dados de perfil, sua linha do tempo, um tweet específico com todas as suas informações, etc.

Além disso, as APIs raramente sofrem alterações no exterior. Isso faz com que qualquer programação feita com eles exija pouca manutenção e não precise de alterações por um longo tempo.

Em resumo, de um aplicativo ou programa específico, você poderá acessar as funcionalidades de outro aplicativo ou programa diferente de maneira rápida e fácil. Interessante, certo?

Bem, essas APIs (depois de fazerem as consultas e funcionalidades correspondentes) retornam um resultado em diferentes formatos. Por exemplo, a API do  WordPress (como você verá abaixo) retorna os dados de suas consultas em JSON. Dessa forma, todos os programas que desejam se conectar à API do WordPress funcionam com o mesmo formato de troca e podem usar as funções da API, apesar de serem de fontes diferentes. Para entender um ao outro: é como se todos nós, sejam do país em que somos e tenhamos a língua materna que temos, falemos inglês.

Depois que a API for desenvolvida (com todo o trabalho necessário), será tarefa do desenvolvedor ou da empresa de desenvolvimento decidir o que é exposto publicamente para o uso de outros usuários da rede. Por exemplo, se você verificar a API do Twitter ou a API do WordPress, verá que elas são muito bem explicadas e documentadas para seu uso, pois estão interessadas em obter um volume maior de usuários de suas redes sociais ou CMS.

Obviamente, como os sites são mais complexos, as APIs são mais necessárias porque permitem conectar novos recursos e funcionalidades ao seu site. Por exemplo, você pode inserir um mapa do Google Maps no seu site com todos os seus recursos, sem precisar codificar e inserir manualmente todos os dados. Você também pode vincular sua loja online desenvolvida no WooCommerce ao seu programa de estoque e contabilidade, para evitar erros e reduzir o tempo de produção.

O que é um serviço REST?

Agora que você sabe o que é uma API e para que ela é usada, explicarei brevemente outro termo que você deve conhecer: REST.

REST (Representational State Transfer) é um estilo de arquitetura usado hoje para descrever uma interface que pode ser usada entre sistemas que usam HTTP para transferência de informações.

Os serviços web REST tornaram-se bastante populares ao longo dos anos. Se você procurar, muitas das empresas com as quais você interage regularmente têm uma: Twitter, Facebook, Amazon, Google Maps, YouTube … e, é claro, WordPress.

É por isso que esses serviços têm várias vantagens importantes :

  • Eles são escaláveis, confiáveis ​​e flexíveis.
  • Eles mal consomem recursos do servidor.
  • A tecnologia, o cliente e o servidor se comunicam através do JSON, o que os torna independentes.

Uma API REST define funções específicas para que os desenvolvedores possam fazer solicitações sobre elas, usando o protocolo HTTP. Tudo isso permite que eles sejam usados ​​por qualquer sistema. Você apenas precisa considerar algumas diretrizes:

  • Use os URIs corretamente: O endereço deve ser exclusivo, pois cada um aponta para um recurso específico e exclusivo. Também deve ser “independente do formato”. Ou seja, se você deseja conceder acesso ao recurso, não adicione sua extensão. Por exemplo: “/raiola/1223.txt” não estaria correto, mas “/ raiola / 1223” estaria. Os URIs também não implicam ações, ou seja, na rota que você não deve adicionar: editar, excluir … Aqui, a única coisa que importa é identificar o recurso de uma maneira única. Essas ações são manipuladas através dos métodos HTTP que você verá mais tarde. Por fim, é importante que o URI mantenha uma hierarquia lógica.
  • Use os métodos HTTP corretamente:  não entrarei em detalhes, porque precisaria dedicar o artigo especificamente para falar sobre o REST, mas explicarei quais são os métodos existentes:
    • GET: Para fazer consultas e ler recursos. Exemplo: GET / raiola / 123
    • POST: Crie um novo recurso. Exemplo: POST / raiola / 123
    • PUT: Edite um recurso existente.
    • DELETE: Para eliminar recursos.
    • PATCH: Para editar partes específicas de qualquer um dos recursos.
  • Implementar o Hypermedia: o cliente não precisa conhecer a API URIS.

O que é JSON?

E, finalmente, antes de se aprofundar no que seria a API do WordPress, você deve saber o que é JSON e como é usado nas APIs. JSON (JavaScript Object Notation) é um formato de texto simples e leve, usado principalmente para armazenar e trocar informações.

Como mencionei anteriormente, esses dados são gerados pela própria API no momento em que um sistema faz uma consulta. Como é texto simples, é independente das linguagens de programação e os sistemas podem interpretá-las sem problemas. Cada idioma possui uma biblioteca que codifica e decodifica dados em JSON.

Sua sintaxe é muito simples:

  • Cada dado consiste em um par de nome e valor. Ou seja, se eu quiser enviar o nome da minha empresa, no JSON seria “empresa”: “Raiola Networks”.
  • Cada dado é separado por vírgulas.
  • O [] contém objetos.
  • O {} cria uma matriz que armazena pares de dados.

Vamos ver um exemplo após esta sintaxe:

Lembre-se de que um par pode conter um grupo de pares dentro do seu valor. Como você pode ver, é auto-descritivo e muito fácil de ler e interpretar por um usuário.

API REST WordPress para desenvolvedores

Neste ponto da postagem, você terá uma idéia clara do que é uma API e quais são seus recursos e funcionalidades básicos. Chegou a hora de transferir tudo o que foi aprendido para o uso da API do WordPress.

A API REST do WordPress faz parte deste CMS desde 2015. É usada para manipular dados textuais de um site para outro, sem acesso direto a um banco de dados ou interface pelo usuário final. Ou seja, este CMS fornece uma interface para outros sistemas interagirem com seu site. Por exemplo, se você criar um aplicativo para celular e tablet, poderá acessar dados do seu site a partir desse aplicativo.

Isso significa que as possibilidades de usar esse gerenciador de conteúdo para qualquer tipo de desenvolvimento são ampliadas, pois a API do WordPress permitirá a integração total com plataformas de terceiros.

Conceitos básicos da API REST do WordPress

Como expliquei a você no início o que é uma API e outros termos relevantes, agora é bom que você conheça brevemente os elementos importantes da API REST do WordPress:

  • Recurso:  é um elemento de informação acessível a partir da API. Por exemplo, na API do WordPress, um recurso pode ser uma página, entrada, usuário …
  • EndPoint:  pontos finais são os caminhos para os recursos. Se você for “yourdomainname / wp-json /», poderá ver todos os pontos de extremidade já disponíveis no seu site. Além disso, na documentação oficial da API do WordPress, você pode ver os URLs dos pontos de extremidade mais usados.
  • Solicitações ou solicitações: solicitações  HTTP feitas para um recurso com a intenção do sistema de retornar uma resposta com informações. Quando um sistema externo ou um plug-in no seu site faz uma solicitação para um recurso da API, o objeto WP_REST_Request é gerado no WordPress.
  • Resposta ou respostas:  são as informações retornadas pela API. Quando isso acontece, uma instância do WordPress da classe WP_REST_Response é criada.
  • Esquema ou esquema:  é um esquema de metadados que informa como os dados devem ser estruturados. No caso da API do WordPress, use o esquema JSON. No exemplo na seção “O que é JSON”, você pode ver como os dados de um nó de extremidade estão estruturados. Embora não seja essencial usar um esquema, é recomendado.
  • Classe do controlador: permite personalizar a API e criar seus próprios EndPoints.

Como ativar a API do WordPress

Por um tempo, especificamente desde a versão 4.7, o WordPress já incorporou nativamente sua API REST. Mas se você não pode acessá-lo, seja por causa da versão do WordPress ou porque sua hospedagem  (por segurança) já o oculta, você sempre pode ativá-lo manualmente instalando um plug-in chamado WP REST API Controller , que pode ser encontrado em o próprio repositório de plugins do seu WordPress.

Depois que o plug-in estiver instalado e ativado, você poderá começar a usar a API do WordPress em seu projeto.

Para acessar a API, você deve sempre começar com o seguinte caminho: http://seudominio.com/wp-json/wp/v2. Porque Vou dividir para você ver:

  • http://seudominio.com: seu URL, embora você também possa trabalhar em http: // localhost local.
  • / wp-json: prefixo da URL da API RP do WP.
  • / wp: nome do URL.
  • / v2: versão da API RP do WP.

Após esse URL, você pode adicionar o recurso a explorar, por exemplo: / posts para ver a lista de postagens publicadas em seu site.

Ao inserir esse caminho no navegador ou no plug-in de leitura JSON, você receberá (se você trabalha com o Mozilla Firefox). Caso contrário, com outros navegadores ou programas, você obterá as mesmas informações, mas com um estilo diferente.

A imagem que você vê acima é um esquema. Como já expliquei antes, nada mais é do que a representação dos dados que forma a resposta da API que eu solicitei anteriormente. Nesse caso específico, as informações de postagem do blog.

Como você pode ver, os campos id, título, conteúdo, autor … fazem parte da resposta fornecida pela API e serão muito úteis para integrações posteriores com outros sistemas.

Para testar essas solicitações e obter os esquemas de resposta, você pode fazê-lo em seu próprio navegador, mas às vezes não é suficiente com isso ou não é muito claro visualmente (especialmente se você usa o Chrome). Portanto, para melhorar sua experiência, recomendo que você use o programa Postman , que permitirá criar os aplicativos de acordo com suas necessidades e visualizar o resultado.

Um exemplo claro e simples do que você pode fazer via API do WordPress pode ser visto na criação de entradas de blog via PHP . Com esse código simples, você pode entrar de um site externo para o WordPress e criar uma nova entrada nele. Tudo isso, sem ter que fazer login no seu back-end.

Autenticação

Obviamente, nem todos podem acessar as informações dos pontos de extremidade. Há informações públicas sobre o seu site e informações particulares. Portanto, em muitas ocasiões, você precisará se autenticar com antecedência para poder trabalhar com os recursos do WordPress solicitados por meio da API, como no caso de criação de usuários ou publicação de postagens e páginas.

Para fazer isso, existem três maneiras de se autenticar na API do WordPress:

  • Através do uso de cookies: é o método de autenticação padrão que está disponível nativamente. Está associado ao usuário da pessoa que você está desenvolvendo para o WordPress. Uma vez logado no painel, um cookie é gerado. Com esse cookie, o desenvolvedor pode acessar a API do WordPress.
  • Plug-in ou complemento: existem complementos que permitem uma alternativa para autenticação de sistemas externos em seu site: API REST do WordPress – OAuth 1.0a Server é um exemplo.

Por meio dessas autenticações, sua API do WordPress será segura e não poderá ser usada por ninguém que a acesse, muito menos por editar seus recursos da web.

Como desativar a API REST do WordPress?

Se você é um daqueles que não confia ou simplesmente não deseja tirar proveito da nova API do WordPress, é melhor que você desative essa funcionalidade. Lembre-se de que se sua versão do WordPress for inferior a 4.7, a API o desativará por padrão. Caso contrário, indico as etapas que você deve seguir para desativar sem usar plug-ins para fazer isso.

Edite o arquivo functions.php, adicionando as seguintes linhas:

É simples assim desativar a API do WordPress sem usar plug-ins

Conclusão

O desenvolvimento e a implementação da API do WordPress podem ter significado um progresso significativo para os desenvolvedores em seu trabalho. Graças a essa versatilidade oferecida pelo WordPress, muitos já optaram por este CMS para implementá-lo na maioria de seus projetos.

E é que a API do WordPress facilitará a conexão entre aplicativos e serviços de terceiros. O que melhorará a experiência do usuário, reduzirá os custos de desenvolvimento e aumentará a funcionalidade do CMS, algo que também beneficia o usuário final do site ou o designer médio.

Além disso, e como uma boa API vale a pena, o WordPress tem seu próprio manual completo de integração da API REST do WordPress e com toda a comunidade ativa deste CMS que existe na rede. Portanto, a facilidade de acesso a recursos, manuais e informações é outra vantagem do uso da API do WordPress.

Se você é um dos que já experimentou a API do WordPress, pode deixar sua mensagem nos comentários para nos contar sua experiência. A comunidade do WordPress agradecerá 🙂

DEIXE UMA RESPOSTA

Por favor digite seu comentário!
Por favor, digite seu nome aqui