API do Interago: o que é e para que serve

A API do Interago é uma porta segura para outros sistemas (ERP, automações, apps) lerem ou atualizarem informações do seu website (por exemplo pedidos, produtos ou conteúdos) com um token.

⚠️ A API precisa estar habilitada para utilizá-la. Veja o passo a passo em API - Como habilitar.

Como chegar

Menu → API Interago (quando disponível no seu site). Para habilitar e gerar o token, veja API - Como habilitar.

Ideia geral (sem jargão)

1. A API precisa estar habilitada para o site.

2. Você gera um token (como uma senha longa): guarde com cuidado.

3. Seus sistemas usam esse token para chamar os métodos permitidos.

Módulos documentados

• API: Módulo Pedidos (orders)

• API: Módulo Relatórios (visits)

• API: Módulo Catálogo (catalog)

• API: Módulo Notícias (news)

• API: Módulo Web Stories (webstories)

• API: Módulo Páginas e Blocos (pages)

• API: Módulo SEO (seo)

• API: Módulo Mídias (media)

• API: Módulo Envios (shipping)

• API: Módulo Cupons (coupons)

• Conta (account): consumo de requisições do mês, explicado em API - Como habilitar

• API: Bloco de Repetição (variante 23)

Segurança

Trate o token como senha. Não publique em páginas públicas nem compartilhe em grupos. Se suspeitar de vazamento, gere um novo token e desative o antigo.

Há também um exemplo prático de rastreio: API : Adicionando código de rastreio a um pedido via Curl.