API

API: Módulo Notícias (news)

Listar artigos e gerenciar rascunhos do blog/portal sem publicar automaticamente.

  • Publicado em 04/08/2026
  • Atualizado em 08/10/2026
  • Equipe do Interago

O módulo news lê artigos, tags e autores, gerencia rascunhos e também tira artigos do rascunho com applyArticleStatus. A API não envia o HTML das matérias para o site: essa etapa continua no painel, em Notícias → Atualizar.

⚠️ 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
  • websiteId no corpo
  • module e method identificando 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 principais

MétodoPara que serve
listArticles / getArticleLista e detalhe; opcionalmente inclui virtual/content.
listTags / getTagAssuntos do portal.
listAuthorsAutores ativos; use o userId retornado em rascunhos novos.
proposeArticleDraft / applyArticleDraftValida e grava rascunho (JSON do editor).
proposeArticleMeta / applyArticleMetaTítulo, capa, tag, SEO e autor.
applyArticleStatusTira o artigo do rascunho (status=1), um por chamada, sem enviar o HTML ao site.

Rascunhos

  • Em artigos novos, authorUserId é obrigatório (venha de listAuthors).
  • O articleJson segue o formato do editor: parágrafos em componentes com HTML em encodeURIComponent.
  • Depois do rascunho pronto, applyArticleStatus tira o artigo do rascunho. O envio das páginas para o site continua no painel (veja a seção abaixo).

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=news&method=listArticles&status=1&page=1&pageSize=20'

Tirar do rascunho: applyArticleStatus

Criou muitos artigos pela API, por exemplo numa migração com centenas de matérias? Não precisa mais abrir um por um no painel só para tirar do rascunho. O método applyArticleStatus faz isso pela API, um artigo por chamada.

  • publishNewsId (obrigatório): o id do artigo, o mesmo que volta em applyArticleDraft e aparece em listArticles.
  • status: por enquanto só 1 (publicado). Para inativar ou voltar a rascunho, use o painel.

O que acontece na chamada:

  • O artigo sai do rascunho no painel e ganha o endereço definitivo (publishNewsUrl e url na resposta).
  • O sitemap de notícias da loja é publicado na hora (sitemapNews: true), como na primeira publicação feita pelo painel.
  • O HTML da matéria não é gerado nem enviado para o site. A resposta avisa isso com nextStep: panel_refresh_news.
  • É seguro repetir: se o artigo já estava publicado, a resposta vem com changed: false e wasDraft: false, sem mudar nada no artigo.
  • Gravação bloqueada para loja do plano grátis (403 FREE_TIER_DENIED).

Depois das chamadas, entre no painel e rode Notícias → Atualizar (atualização parcial ou completa), ou use o card Notícias em Menu → Atualizar. É essa etapa que gera e envia as páginas das matérias para o site. Numa migração, vale fazer todas as chamadas primeiro e rodar uma única atualização no final.

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=news&method=applyArticleStatus&publishNewsId=123&status=1'

Erros que podem aparecer:

CódigoO que significa
400 ARTICLE_ID_REQUIREDFaltou o publishNewsId.
400 STATUS_UNSUPPORTEDSó status=1 é aceito por enquanto.
403 FREE_TIER_DENIEDLoja do plano grátis.
404 ARTICLE_NOT_FOUNDO artigo não existe nesta loja.
409 ARTICLE_INACTIVEArtigo inativo; reative no painel antes.
409 DRAFT_EMPTYRascunho sem conteúdo; grave com applyArticleDraft antes.

Layouts

Também existem métodos de layout (home, web, tag, author, data, amp, menu) com propose/apply e histórico de versões.

Este artigo foi útil?