O recurso da API REST está disponível no All in One SEO Lite e no All in One SEO Pro e permite buscar e atualizar facilmente dados do AIOSEO via API REST.
Isso pode ser particularmente útil quando você, por exemplo, tem:
- Um site WordPress headless onde você precisa exibir manualmente seus dados de SEO no frontend;
- Um sistema de terceiros para gerenciar seus posts (por exemplo, ERP de eCommerce com integração WooCommerce) e gostaria de poder gerenciar seus dados de SEO através desse sistema.
Abaixo explicaremos quais dados estão disponíveis via API REST e como você pode atualizá-los.
Buscando Dados
OBSERVAÇÃO:
O recurso da API REST no All in One SEO está disponível como parte do plugin principal e está disponível tanto no All in One SEO Lite quanto no All in One SEO Pro. Ele não precisa mais de um plugin de complemento separado.
Em vez de registrar endpoints personalizados, a API REST se integra aos endpoints padrão do WordPress Core. Atualmente, todas as rotas GET de posts e termos são suportadas.
Estas incluem:
- /wp/v2/posts
- /wp/v2/pages
- /wp/v2/media
- /wp/v2/categories
- /wp/v2/tags
E também todas as rotas para tipos de post personalizados e taxonomias personalizadas em seu site que têm suporte para a API REST habilitado.
Os seguintes campos serão incluídos na resposta dessas rotas:
aioseo_head
Este campo inclui os dados brutos de SEO que normalmente seriam exibidos pelo All in One SEO no código-fonte do seu post/termo como uma string de texto.
Se você tem um site WordPress headless, pode exibir esses dados diretamente no código-fonte do frontend da sua instalação.
aioseo_head_json
Este campo inclui os mesmos valores dos dados aioseo_head (veja acima), mas em formato JSON.
Isso permite que você filtre facilmente os dados antes de exibi-los no código-fonte ou usá-los para outro propósito.
Observe que esses dados não incluem o código HTML para as meta tags para as quais esses valores são usados, portanto, você precisará construí-los sozinho.
aioseo_meta_data
Este campo inclui os dados que são armazenados nas tabelas personalizadas de posts e termos do AIOSEO em formato JSON.
Esses dados devem ser usados principalmente quando você deseja manipular os dados existentes e, em seguida, atualizá-los em seu site.
Atualizando Dados
Para atualizar dados via API REST, você deve se autenticar. Se você não tem certeza de como fazer isso, leia a documentação da API REST do WordPress.
O usuário com o qual você se autenticou também deve ter qualquer uma das seguintes capacidades para poder atualizar quaisquer dados do AIOSEO via API REST:
- aioseo_page_general_settings
- aioseo_page_social_settings
- aioseo_page_schema_settings
- aioseo_page_advanced_settings
Depois de atender a esses requisitos, você pode atualizar dados por meio de uma solicitação POST/PUT adicionando a propriedade aioseo_meta_data no corpo da solicitação.
Dentro desta propriedade, você pode especificar qualquer uma das chaves incluídas no campo aioseo_meta_data (veja acima), juntamente com o novo valor.
Abaixo está um exemplo de como isso se parece:
{
"aioseo_meta_data": {
"title":"NEW TITLE",
"description":"NEW DESCRIPTION"
}
}Se você tiver alguma dúvida específica sobre a API REST, sinta-se à vontade para entrar em contato com nossa equipe de suporte. Teremos prazer em ajudá-lo.