API - Como habilitar

Neste artigo você habilita a API do Interago no painel e gera o token usado nas integrações.

Antes de começar

• Acesse o painel do website em que a API será usada.
• O menu API Interago precisa estar disponível para o seu site.
• Trate o token como senha: não publique em páginas, repositórios públicos ou chats.

Passo a passo no painel

1. Abra API Interago no menu. A tela Geral corresponde a #api.main?general.

2. Em Configuração global, confira o Endpoint e o websiteId exibidos na página.

3. Clique em Gerar novo token. Cada usuário tem o próprio token. Confirme o aviso: gerar um novo token invalida o seu token anterior neste website, então atualize as integrações que usavam ele.

4. Ative o interruptor API ativa.

5. Clique em Salvar. Sem token gerado, não é possível ativar a API.

O que anotar para as integrações

• websiteId: número do website (aparece na tela Geral)
• Endpoint: https://app.interago.com.br/App/Api/index.php
• Token: use no cabeçalho Authorization: Bearer SEU_TOKEN (substitua pelo valor gerado; nunca use um token de exemplo)

Como usar o token

Todas as chamadas são POST com:

• Cabeçalho Authorization: Bearer SEU_TOKEN
• websiteId, module e method no corpo

Exemplo genérico:

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=orders&method=listOrders&dateFrom=2026-01-01&dateTo=2026-01-31&page=1&pageSize=20'

No painel, o testador e a documentação de cada método ficam em #api.main?{módulo}&{método}.

Limites e bloqueio

• Limite padrão: 60 requisições autenticadas por minuto por website.
• Se o limite for extrapolado, a API do website pode ser bloqueada automaticamente. Nesse caso, a tela Geral mostra o aviso e é preciso contatar a equipe Interago para desbloqueio.

Cota do mês

Além do limite por minuto, cada website tem uma cota mensal de requisições. A barra Uso neste mês, na tela Geral de API Interago, mostra o consumo em tempo real.

• Loja do plano grátis ou sem faturamento Interago: 100 requisições de cortesia por mês. Ao chegar em 100, a API pausa até o dia 1º do mês seguinte (as chamadas respondem API_QUOTA_EXCEEDED). Para continuar antes disso, faça o Upgrade ou ative a cobrança Interago.

• Loja com faturamento Interago: depois das 100 primeiras, a API segue em pacotes de 8.000 requisições (R$ 50 por pacote). Quando um pacote acaba, o próximo abre sozinho e entra na fatura; os detalhes ficam em Faturamento.

• Chamadas feitas com token da equipe Interago não entram na cota do site.

Quanto já usei no mês: account.getUsage

Para a integração saber sozinha quanto ainda pode chamar, use o método getUsage do módulo account (Conta). Ele devolve os mesmos números da barra Uso neste mês.

• Não conta na cota e responde mesmo com a cota esgotada (nesse caso, com remaining: 0).
• O limite de 60 requisições por minuto continua valendo para ele também.
• Não precisa de parâmetros além de websiteId, module e method.

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=account&method=getUsage'

Campos principais de usage na resposta:

• used: requisições contadas no mês (period), que zeram em resetsAt.
• billingModel: courtesy (cortesia de 100, a API pausa ao zerar) ou packages (faturamento Interago, pacotes de 8.000).
• limit, usedInCycle e remaining: o teto do ciclo atual, quanto já foi usado nele e quanto falta.
• pausesAtLimit: com true, ao zerar remaining a API pausa até resetsAt; com false, abre o próximo pacote.
• packagesOpened: pacotes de 8.000 já abertos no mês.
• tokenCountsUsage: false quando o token é da equipe Interago e não soma no uso.

O bloco rateLimit traz perMinute, usedThisMinute e remainingThisMinute (a própria chamada já entra nessa conta). Dica: consulte o getUsage antes de uma carga grande, como uma migração, e programe as chamadas para não ser pego pela pausa no meio do caminho.

Segurança

• Não compartilhe o token. Quem tiver o token pode chamar os métodos permitidos no seu website.
• Se suspeitar de vazamento, gere um novo token (o anterior deixa de valer) e atualize as integrações.
• Para desativar temporariamente, desligue API ativa e salve.

Próximos passos

Com a API habilitada, consulte os artigos por módulo na tag API (Pedidos, Relatórios, Catálogo, Notícias, Web Stories, Páginas e Blocos, Bloco de Repetição, SEO, Mídias e Envios). O módulo mais novo é o API: Módulo Envios (shipping), com faixas de CEP e medidas de frete dos produtos.