Gênios Academy

Dicas e tutoriais para amantes do wordpress

Visão geral do tipo de consulta da API REST do Query Builder

Como configurar o tipo de consulta da API REST

Por exemplo, obtivemos o endpoint da API REST do tipo de conteúdo personalizado com itens contendo informações sobre filmes.

Vá para JetEngine> Query Builder e clique no botão “Adicionar novo ”. Nomeie uma nova consulta e selecione o tipo de consulta “Consulta da API REST” .

Depois disso, você verá dois recursos da consulta da API REST :

configurações de consulta da API rest

  • Do ponto final. Neste menu suspenso, você verá a lista de todos os Endpoints que você criou para o site. Escolha o que você precisa;
  • Consulta. Esta é a seção que permite criar uma consulta. Insira o nome do metacampo na barra Chave e, em seguida, digite o valor na área de texto Valor . Se o valor do metacampo chave for igual ao valor na barra Valor , o item será adicionado à lista.

Como Valor, você também pode selecionar uma das macros da lista. Saiba mais sobre eles em nosso Guia de Macros .

macros de consulta da API RESTPor um instante, você pode inserir o nome do metacampo do ID do autor como a chave e as macros “ID do usuário atual” como o valor . Assim o usuário verá apenas os itens de sua autoria na página.

uso de macros em exemplo de consultaPara começar, criamos uma consulta sem chaves e valores. 

consulta sem chaves e valoresA tabela dinâmica baseada nesta consulta mostra todos os itens.

tabela dinâmica criada com a consultaAbra o URL do terminal da API em seu navegador. Você poderia usar qualquer editor de código para organizar itens como esse.

editor de códigoNesta captura de tela, as áreas de texto em preto são chaves que são metacampos. As áreas de texto verdes são valores.

Por exemplo, escolhemos a chave “contentRating” e o valor “R”.

adicionando nova chave e valor à consultaEm seguida, criamos a Tabela Dinâmica com esta consulta. Como configuramos a consulta, ela mostra apenas filmes com classificação de conteúdo R.

visualização da tabelaSe você adicionar uma nova chave e um novo valor à consulta, poderá restringir o resultado. Por exemplo, inserimos a chave “gêneros” e o valor “Horror”.

estreitando a consulta com nova chave e valorE agora, a tabela mostra apenas dois itens com os valores Horror e R.

tabela dinâmica com o resultado final

Consulta de API REST com API de terceiros

Não deve haver problemas ao consultar REST API Endpoint , que foi obtido do JetEngine Custom Content Type , como aquele com filmes que consultamos antes. Mas a consulta da API REST não funciona com todas as APIs.

Temos uma demonstração da tabela de dados da API REST baseada na API IMDb . Você pode criar uma tabela semelhante com a mesma API obtida na documentação da API do IMDb , mas não poderá consultá-la.

Isso porque quando você adiciona chaves e valores à consulta, eles aparecem após um ponto de interrogação “?” no ponto final. Em outras palavras, a API IMDb possui um tipo de parâmetros de caminho . O tipo de parâmetro de string de consulta para APIs é obrigatório para o Query Builder.

No entanto, você pode consultar itens da IMDb diretamente na página de documentação da API da IMDb.

página de documentação da API imdb

Isso é tudo. Agora você aprendeu como configurar a consulta da API REST, usar chaves e valores e quais APIs de terceiros são adequadas para o JetEngine Query Builder.