Voltar ao início

Documentação da API

API REST Index Instantâneo — version 1

Começo rápido

1. Pegue uma chave

Disponível em todos os planos, em Painel → Perfil → Acesso à API.

2. Envie suas URLs

Um POST no endpoint de envio. Até 500 URLs por requisição, processadas em blocos de 3.

3. Acompanhe o rastreamento

O histórico mostra em que pé está cada URL. Ele fica guardado por 48 horas.

Autenticação

Os endpoints autenticados esperam a sua chave no cabeçalho Authorization: Bearer. As chaves começam por ixpt_ e são geradas em Painel → Perfil → Acesso à API.

# A sua chave de API autentica cada requisição
curl https://indexinstantaneo.com/api/user/credits \
  -H "Authorization: Bearer ixpt_SUA_CHAVE_DE_API"

A sua chave vale como a sua senha: nunca a coloque em código enviado ao navegador, num repositório público ou numa URL. Se ela vazar, gere outra pelo painel — a antiga para de funcionar na hora.

Limites

500

URLs por requisição

3 URLs

Tamanho do bloco

48 horas

Histórico guardado

10 req/s

Taxa

Endpoints

POST/api/indexing/submitPrecisa de chave

Enviar URLs

Envia até 500 URLs ao Google. Elas entram numa fila e são processadas em blocos de 3.

Corpo da requisição

{
  "urls": [
    "https://seusite.com.br/pagina-1",
    "https://seusite.com.br/pagina-2",
    "https://seusite.com.br/pagina-3"
  ]
}

Resposta

{
  "success": true,
  "submitted": 3,
  "failed": 0,
  "creditsUsed": 3,
  "remainingCredits": 61,
  "results": [
    { "url": "https://seusite.com.br/pagina-1", "status": "submitted" },
    { "url": "https://seusite.com.br/pagina-2", "status": "submitted" },
    { "url": "https://seusite.com.br/pagina-3", "status": "submitted" }
  ]
}

Erros

  • 400Nenhuma URL válida foi informada
  • 402Créditos insuficientes
  • 429Requisições demais — diminua o ritmo
  • 503Serviço de indexação indisponível
GET/api/indexing/history?page=1&limit=20Precisa de chave

Consultar o histórico

Devolve seus envios, paginados. As URLs ficam guardadas por 48 horas.

Resposta

{
  "submissions": [
    {
      "_id": "abc123",
      "url": "https://seusite.com.br/pagina-1",
      "status": "submitted",
      "searchEngine": "google",
      "creditsUsed": 1,
      "createdAt": "2026-09-07T12:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45,
    "pages": 3
  }
}

Erros

  • 401Chave de API ausente ou inválida
GET/api/user/creditsPrecisa de chave

Consultar o seu saldo

Devolve o seu saldo de créditos, o seu plano e o custo de um envio.

Resposta

{
  "credits": 80,
  "planName": "Descoberta",
  "planExpiresAt": "2099-12-31T00:00:00Z",
  "creditCosts": { "credit_cost_url_indexing": 1 }
}

Erros

  • 401Chave de API ausente ou inválida
GET/api/plansPublic

Listar os planos

Devolve todos os planos ativos. Não precisa de autenticação.

Resposta

{
  "plans": [
    {
      "name": "Descoberta",
      "price": 5,
      "credits": 80,
      "currency": "USD",
      "billingPeriod": "lifetime",
      "features": ["80 créditos de indexação", "…"]
    }
  ]
}

Alguma dúvida sobre a API? Fale com a gente, respondemos em até 24 horas.