API: Módulo SEO (seo)
Dados fixos e SEO por página da extensão SEO Avançado.
- Publicado em 04/08/2026
- Atualizado em 08/10/2026
- Equipe do Interago
O módulo seo gerencia dados fixos e SEO por página (extensão 3 — SEO Avançado). Configure os dados fixos antes de gravar SEO das páginas.
⚠️ A API precisa estar habilitada para utilizá-la. Veja o passo a passo em API - Como habilitar.
Endpoint: https://app.interago.com.br/App/Api/index.php
Todas as chamadas são POST com:
- Cabeçalho
Authorization: Bearer SEU_TOKEN websiteIdno corpomoduleemethodidentificando o recurso
Ative a API e gere o token em #api.main?general (veja API - Como habilitar). Limite: 60 requisições autenticadas por minuto por website. Trate o token como senha.
No painel, o testador e a documentação do método ficam em #api.main?{módulo}&{método}.
Métodos
| Método | Para que serve |
getEssentials | Dados fixos + pré-requisitos de cada schema. |
updateEssentials | Upsert parcial dos dados fixos (só campos enviados mudam). |
listPageSeo | Lista SEO das páginas (máx. 50; search / pageIds). |
getPageSeo | SEO resolvido (salvo ou defaults). |
applyPageSeo | Upsert do SEO da página; campos omitidos mantêm o valor atual. |
Dados fixos obrigatórios
No resultado final de updateEssentials precisam existir: seoAuthor, seoOrganizationName, seoOrganizationPhone e seoBaseHref (URL https).
Toggles de página exigem pré-requisitos nos dados fixos, por exemplo:
- social: nome + país + logo
- organization / article: logo + URL da organização
- store: CEP, logo, endereço, horário da semana e faixa de preço
curl -X POST 'https://app.interago.com.br/App/Api/index.php' \ -H 'Authorization: Bearer SEU_TOKEN' \ -H 'Content-Type: application/x-www-form-urlencoded' \ -d 'websiteId=SEU_WEBSITE_ID&module=seo&method=getEssentials'
Escritas podem retornar 403 FREE_TIER_DENIED em lojas free-tier e 403 SEO_EXTENSION_REQUIRED se a extensão 3 não estiver instalada.
Este artigo foi útil?
