Como configurar o endpoint da API REST para consulta personalizada

Antes de começar, verifique os requisitos do tutorial:

  • Elementor (versão gratuita), ou editor de blocos WordPress (Gutenberg), ou Bricks

  • Plug-in JetEngine instalado e ativado

REST API é uma interface de programação que permite criar conexões entre seu site e outro site ou aplicativo. Com a opção Register Rest API Endpoint para o recurso JetEngine Query Builder , você pode transferir os dados consultados.

Como exemplo, criaremos uma consulta de tipo de conteúdo personalizado para transferir eventos consultados para outro site WordPress.

Prepare um tipo de conteúdo personalizado no site principal

No site principal, vá para WordPress Dashboard> JetEngine> guia JetEngine e certifique-se de ativar a alternância de tipo de conteúdo personalizado .

habilitar o módulo de tipo de conteúdo personalizado

Em seguida, vá para WordPress Dashboard> JetEngine> Custom Content Types e clique no botão “ Add New ” ou clique para editar o CCT criado, quais itens você deseja transferir.

criar ou editar um tipo de conteúdo personalizado

Essas configurações são necessárias na seção Configurações Gerais : insira o Nome e o Slug será preenchido automaticamente no campo Nome . Você pode alterar o Slug ao criar o CCT, mas use apenas letras latinas aqui e evite espaços: use hífens ou sublinhados.

Outras configurações são opcionais para transferir os itens CCT via REST API. Leia mais sobre eles na Visão geral do tipo de conteúdo personalizado (CCT) .

tipo de conteúdo personalizado de eventos

Na guia Configurações de campos , adicionamos os seguintes metacampos: o campo Nome “Texto”, o campo Data “Data” e o campo “Mídia” da imagem.

O campo “Mídia” requer mais atenção.

Aviso

Se você escolher o formato de valor “ID de mídia” e recuperar a imagem por meio da API REST, poderá surgir um conflito se já existir uma imagem com o mesmo ID no site secundário. Portanto, recomendamos definir o formato de valor “URL de mídia” .

formato do valor do URL de mídia

Ajuste todas as configurações desejadas para o CCT e pressione o botão “ Adicionar/Atualizar Tipo de Conteúdo ”.

Em seguida, prossiga para a guia do menu CCT no painel do WordPress e crie vários itens CCT clicando no botão “ Adicionar novo ” e preenchendo os metacampos.

criação de itens cct

Crie uma consulta no site principal

Vá para WordPress Dashboard> JetEngine> guia Query Builder e clique no botão “ Adicionar novo ”.

Na seção Configurações gerais , insira o nome da consulta e selecione o tipo de consulta “ Consulta de tipo de conteúdo personalizado ” . 

crie uma consulta de tipo de conteúdo personalizada

Em seguida, ative a alternância Register Rest API Endpoint para desdobrar uma seção com mais configurações para o registro do endpoint.

Uma descrição detalhada de todas as opções pode ser encontrada no capítulo Register Rest API Endpoint .

Você pode definir o Endpoint Namespace e o Endpoint Path adequados para melhorar o SEO do seu site WordPress.

acesso restrito para o endpoint também pode ser definido. Você pode configurar o acesso ou entrada pública apenas para usuários com determinadas funções ou capacidades.

Você pode ajustar os argumentos de consulta para personalizar o conteúdo retornado por um servidor web. Por exemplo, inserimos um NOME DO ARGUMENTO DE CONSULTA “classificar” e VALOR PADRÃO “asc” para classificar itens (eventos) por data, do mais antigo para o mais recente.

Registrar Rest API Endpoint para a consulta

Na seção Configurações de consulta de tipos de conteúdo , selecione o CCT necessário na lista suspensa Do tipo de conteúdo .

Os argumentos registrados devem ser mapeados para as configurações da consulta.

No nosso caso, clicamos no botão “ Adicionar novo parâmetro de classificação ” na seção Ordenar e Ordenar por . Definimos a ordem por “Data”, a ordem “Do menor para o maior (1, 2, 3; a, b, c)” e o tipo “Data” para classificar itens (eventos) por data, do mais próximo ao mais próximo. mais recente.

classificando itens do cct por data

Ajuste outras configurações de consulta de acordo com suas necessidades e clique no botão “ Adicionar/Atualizar Consulta ”.

Copie o URL do endpoint da API Rest ou o exemplo de URL do endpoint da API Rest com argumentos de consulta se você adicionar argumentos de consulta ao endpoint.

copie o URL do endpoint da API Rest com argumentos de consulta

Adicione o URL do endpoint da API REST ao segundo site

No segundo site, siga o caminho WordPress Dashboard > JetEngine > JetEngine no segundo site para onde deseja transferir os itens CCT consultados e ative o botão Rest API Listings . Pressione o botão “ Salvar ” e aguarde até que o recarregamento da página seja concluído. 

Módulo de listagens da API Rest

Depois disso, a aba Rest API Endpoints estará disponível. Abra-o e clique no botão “ + Novo Endpoint ”.

Digite o nome do endpoint (opcional), insira o URL copiado no campo URL do endpoint da API , o caminho dos itens “/” e defina a autorização , se necessário.

Todas as configurações estão descritas no capítulo Módulo REST API .

Em seguida, clique no botão “ Enviar solicitação ” para enviar uma solicitação de amostra para verificar a conexão do endpoint da API e buscar os campos disponíveis. Você obterá o status “Conectado” se tudo progredir sem problemas.

Por fim, pressione o botão “ Salvar ”.

adicionando um URL de terminal da API REST

Crie um modelo de listagem para o endpoint da API REST

No segundo site, vá para WordPress Dashboard > JetEngine > Listings e clique no botão “ Add New ”.

Selecione a fonte da listagem “REST API Endpoint” e escolha o endpoint adicionado recentemente no menu suspenso Do endpoint da API . Digite o nome do item da Listagem (opcional) e defina uma das visualizações da Listagem (pode ser “Elementor”, “Blocos (Gutenberg)” ou “Tijolos”). Por exemplo, escolhemos o editor Elementor.

Por último, clique no botão “ Criar item de listagem ”.

item de listagem de configuração para o endpoint restante da API

Na página de edição, coloque o widget Campo Dinâmico . Mantenha a fonte “Post/Term/User/Object Data” . No menu suspenso Campo de objeto , role para baixo até a seção API REST e selecione o metacampo necessário cujos dados você deseja exibir.

Primeiro, escolhemos o metacampo “nome”.

Metacampos da API REST

Em seguida, duplicamos o widget e escolhemos o metacampo “data”. Para os tipos de metacampo “Data”, você pode ativar a alternância de saída do campo Filtro e escolher o retorno de chamada “Formatar data” para personalizar o formato da data.

Leia sobre Personalização do formato de hora e data .

Saiba mais sobre os retornos de chamada de campo dinâmico .

formato de retorno de chamada de data para o campo dinâmico

A imagem pode ser exibida de duas maneiras. A primeira é colocar o widget Dynamic Image e escolher o metacampo “Media” (“imagem”, no nosso caso) necessário na seção REST API como Source .

widget de imagem dinâmica

Como segunda forma, para o widget Campo Dinâmico , escolhemos o metacampo “imagem”, habilitamos a alternância de saída Personalizar campo e inserimos “<img src=’%s’/>” na área de texto Formato do campo .

personalizar a saída do campo

Ajuste outras configurações do modelo de listagem e clique no botão “ Atualizar ”.

Verifique o resultado

Para colocar a listagem, abra a página necessária no Elementor, bloco WordPress ou editor Bricks, coloque a Listing Grid lá e escolha a LISTING recentemente criada no menu suspenso.

Os eventos em nosso bloco Listing Grid são exibidos em ordem crescente por datas.

Defina as configurações da página e da grade de listagem e clique no botão “ Publicar/Atualizar ”.

grade de listagem com eventos transferidos na página

Isso é tudo. Agora você sabe como configurar o endpoint da API REST para consultas personalizadas e como transferir os itens CCT consultados de um site para outro com o plugin JetEngine WordPress.

Índice