Visão geral da API REST

A API REST pode ser ativada seguindo o diretório WordPress Dashboard > JetEngine . 

A guia Módulos é aberta por padrão. A alternância Rest API Listings deve ser ativada e o botão “ Salvar ” deve ser clicado.

Se o módulo estiver ativado, a nova guia REST API Endpoints ficará disponível.

Um novo item pode ser adicionado com o botão “ Novo Endpoint ”.

Uma vez clicado, os campos para edição aparecem.

• Nome — título do endpoint, visível na lista;
• URL do endpoint da API — um campo para o URL dos endpoints da API de onde os dados serão obtidos;
• Caminho dos itens — se a URL leva você para a página onde apenas os itens estão armazenados, deixe a barra (/) neste campo. E caso existam várias pastas, defina aqui o caminho dos itens. Por exemplo, existem três pastas, mas os itens necessários estão naquela chamada “itens”. Então você deve escrever “/items” neste campo. Você pode ler a solução de problemas dedicada sobre como obter o caminho correto do item . Aqui você também pode descobrir como configurar a API no site RapidAPI ;
• Autorização — ative esta alternância para autorizar o endpoint. Se ativado, o campo Tipo de autorização aparece, onde você pode selecionar entre as opções “Senha do aplicativo”, “Token do portador”, “Cabeçalho personalizado” e “RapidAPI”.

Dependendo do tipo escolhido, diferentes campos para personalização serão exibidos.

Para a “Senha do aplicativo”, é:

• User:password string — defina o usuário e a senha do aplicativo separados por “:”.

O “Token do Portador” inclui:

• Token do portador — digite o token para o tipo de autorização do portador.

As configurações de “Cabeçalho Personalizado” consistem em dois campos:

• Nome do cabeçalho — preencha o campo com o nome do cabeçalho de autorização. Ele pode ser encontrado na documentação da sua API;
• Valor do cabeçalho – cole o valor do cabeçalho de autorização localizado nos documentos da API ou no perfil do usuário relacionado a esta API.

A opção “RapidAPI” exibe as seguintes configurações:

• Chave RapidAPI – cole a chave RapidAPI nas configurações do endpoint que podem ser encontradas no site rapidapi.com ;
• Host RapidAPI — cole o host RapidAPI; ele também está localizado nas configurações.

As seguintes configurações do endpoint contêm:

• Status — um campo que verifica se o endpoint funciona corretamente. Lembre-se que o status “Conectado” é essencial ao trabalhar com o Listing Grid ;
• Solicitação de amostra — um campo que envia uma solicitação de amostra para testar a autorização e busca os dados da amostra. Para ativá-lo, pressione o botão “ Enviar Solicitação ”;
• Cache – uma alternância que faz com que as respostas sejam descontadas de acordo com seus argumentos de consulta. Isso reduzirá suficientemente a velocidade de resposta. O saque pode ser realizado regularmente e você pode escolher o período no menu suspenso Período de duração do cache e o número de minutos/horas/dias na barra de valor Duração do cache .

O botão “ Salvar ” salva o endpoint criado e suas customizações.

Os terminais da API REST podem ser registrados para tipo de conteúdo personalizado. Quatro ações podem ser realizadas nos itens do CCT:

• Registre-se para obter itens/item REST API Endpoint 

Você pode aprender mais sobre como criar um endpoint da API REST do item GET e as configurações disponíveis quando a alternância mencionada for ativada.

• Registrar criar itens/item REST API Endpoint 

Descubra mais informações sobre o endpoint da API REST Criar item .

• Registrar item de atualização REST API Endpoint 

O Update Item REST API Endpoint deve ser ativado caso seja esperada a possibilidade de reescrever as informações pelos usuários.

• Registrar excluir item REST API Endpoint 

Também existe a possibilidade de usar o endpoint da API REST Excluir item .

O recurso REST API também pode ser aplicado ao JetEngine Relationships. Seguindo a guia Painel do WordPress > JetEngine > Relações e abrindo a página de edição de relação necessária, a alternância Registrar obtenção de itens/item REST API Endpoint pode ser ativada.

• Endpoint URL — um campo onde os URLs do endpoint podem ser obtidos;
• Capacidade de acesso — um campo para definir o acesso aos terminais. O campo pode ser deixado vazio para permitir o acesso a todos os usuários, ou as capacidades do usuário podem ser coladas aqui para limitar o acesso. Por exemplo, “create_sites” torna o endpoint visível apenas para Super Admin.

Mais uma alternância apresentada é Registrar atualização REST API Endpoint .

Leia mais sobre como obter e atualizar dados de relação por meio da API REST .

Aqui, as configurações de personalização serão as mesmas do recurso Registrar obter itens/item REST API Endpoint .

No entanto, existem diferentes opções de URL apresentadas para seleção.

Os metacampos também podem ser disponibilizados por meio da API REST. Para ativar o recurso, as configurações do metacampo devem ser abertas (pode ser meta post/user/taxonomy).

Em seguida, a alternância Mostrar na API REST deve ser habilitada no metacampo necessário. 

Assim que a meta box /CPT for atualizada clicando no botão correspondente, o metacampo fica disponível para obtenção/atualização via API REST.

Postagens

Para encontrar o metacampo de tipo de postagem no futuro, uma URL semelhante deve ser seguida: “https://website/wp-json/wp/v2/posts”, onde ‘website’ representa o domínio do seu site e ‘posts’ indica qual tipo de postagem ou outro objeto que acessamos.

Além disso, é importante prestar atenção ao recurso Mostrar API em repouso na guia Configurações avançadas das configurações de tipo de postagem. Deve estar habilitado; caso contrário, os metacampos não estarão disponíveis via REST API.

Taxonomias

Se o metacampo estiver conectado à taxonomia, em vez dos ‘posts’, deverá ser colocado o slug da taxonomia. Por exemplo, “https://website/wp-json/wp/v2/my_category”.

Usuários

Se o metacampo for aplicado a usuários, o slug deverá ser ‘usuários’. O link ficará assim: “https://website/wp-json/wp/v2/users”.

Páginas de opções

Para chegar à meta da página Opções , o slug ‘settings’ deve ser colocado no final da URL, como: “https://website/wp-json/wp/v2/settings”.

Mais informações sobre casos de uso da API REST podem ser encontradas no artigo JetEngine REST API: recursos e casos de uso do nosso blog.