Referência da API

Documentação da API de Indexação de URLs

A API de indexação de URLs do IndexBolt permite-te submeter URLs ao Google para indexação, acompanhar o progresso das submissões e gerir créditos programaticamente. Integra a indexação de URLs em massa nos teus fluxos de trabalho SEO, plugins WordPress ou ferramentas personalizadas.

URL base: https://indexbolt.com/api/v1•Pedido e resposta JSON•Autenticação por Bearer token

Autenticação#

Todos os pedidos à API requerem um Bearer token no cabeçalho Authorization. Gera chaves API a partir das definições do teu painel.

Exemplo de cabeçalho de pedido

Authorization: Bearer ib_your_api_key_here

Importante: As chaves API começam com o prefixo ib_. Mantém as tuas chaves em segredo — não as exponhas em código client-side. Podes criar até 5 chaves API por conta.

Limites de Tráfego#

Os limites de tráfego são aplicados por chave API usando uma janela deslizante. Quando o limite de tráfego é atingido, vais receber um código de estado 429.

Endpoint	Limite	Janela
`POST /submit`	10 pedidos	60 segundos
`GET /balance`	30 pedidos	60 segundos
`GET /submissions, /submissions/:id`	60 pedidos	60 segundos

Os cabeçalhos de resposta X-RateLimit-Remaining e X-RateLimit-Reset indicam o teu uso atual.

Tratamento de Erros#

Todos os erros retornam uma estrutura JSON consistente:

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description"
  }
}

Estado HTTP	Código	Descrição
`400`	`INVALID_INPUT`	Corpo do pedido ou parâmetros inválidos
`401`	`UNAUTHORIZED`	Chave API em falta ou inválida
`402`	`INSUFFICIENT_CREDITS`	Créditos insuficientes para a operação
`403`	`FORBIDDEN`	Email não verificado
`404`	`NOT_FOUND`	Recurso não encontrado
`429`	`RATE_LIMITED`	Demasiados pedidos
`500`	`INTERNAL_ERROR`	Erro inesperado no servidor

Créditos e Preços#

Indexação Normal

1 crédito / URL

Processamento padrão. Os URLs são submetidos ao Google para indexação.

Indexação Instantânea

10 créditos / URL

Processamento prioritário para resultados de indexação mais rápidos.

Os créditos nunca expiram. Cada submissão pode conter entre 1 e 1.000 URLs. URLs inválidos são filtrados e não consomem créditos.

Submeter URLs#

POST/api/v1/submit10 ped / 60s

Submete um lote de URLs para indexação no Google.

Corpo do Pedido

Parâmetro	Tipo	Obrigatório	Descrição
`urls`	string[]	Obrigatório	Array de URLs a indexar (1–1.000)
`indexingType`	string	Obrigatório	"normal" ou "instant"
`projectId`	string	Opcional	Associar a um projeto
`submissionName`	string	Opcional	Nome personalizado para a submissão

Exemplo de Pedido

cURL

curl -X POST https://indexbolt.com/api/v1/submit \
  -H "Authorization: Bearer ib_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example.com/page-1",
      "https://example.com/page-2"
    ],
    "indexingType": "normal"
  }'

Resposta — 201 Created

{
  "success": true,
  "data": {
    "submissionId": "sub_abc123",
    "totalUrls": 2,
    "creditsUsed": 2,
    "balanceAfter": 98,
    "invalidUrls": []
  }
}

Validação de URL: Os URLs têm de usar HTTP/HTTPS, ter menos de 2.048 caracteres e apontar para endereços públicos. IPs privados/internos (localhost, 10.x.x.x, 192.168.x.x, etc.) são rejeitados. URLs duplicados são automaticamente removidos.

Listar Submissões#

GET/api/v1/submissions60 ped / 60s

Recupera uma lista paginada das tuas submissões.

Parâmetros de Query

Parâmetro	Tipo	Obrigatório	Descrição
`page`	integer	Opcional	Número da página (padrão: 1)
`pageSize`	integer	Opcional	Resultados por página, máximo 100 (padrão: 20)
`status`	string	Opcional	"queued", "processing", "completed", "partial_failure" ou "failed"

Exemplo de Pedido

cURL

curl https://indexbolt.com/api/v1/submissions?page=1&pageSize=10 \
  -H "Authorization: Bearer ib_your_api_key"

Resposta — 200 OK

{
  "success": true,
  "data": {
    "submissions": [
      {
        "id": "sub_abc123",
        "name": "Submission #1",
        "status": "completed",
        "indexingType": "normal",
        "totalUrls": 5,
        "creditsUsed": 5,
        "createdAt": "2025-01-15T10:30:00Z",
        "completedAt": "2025-01-15T11:45:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 10,
      "total": 45,
      "totalPages": 5
    }
  }
}

Obter Submissão#

GET/api/v1/submissions/:id60 ped / 60s

Obtém os detalhes completos de uma submissão, incluindo o estado por URL.

Parâmetros de Caminho

Parâmetro	Tipo	Obrigatório	Descrição
`id`	string	Obrigatório	O ID da submissão

Exemplo de Pedido

cURL

curl https://indexbolt.com/api/v1/submissions/sub_abc123 \
  -H "Authorization: Bearer ib_your_api_key"

Resposta — 200 OK

{
  "success": true,
  "data": {
    "id": "sub_abc123",
    "name": "Submission #1",
    "status": "completed",
    "indexingType": "normal",
    "totalUrls": 5,
    "creditsUsed": 5,
    "createdAt": "2025-01-15T10:30:00Z",
    "completedAt": "2025-01-15T11:45:00Z",
    "urls": [
      { "url": "https://example.com/page-1", "status": "completed" },
      { "url": "https://example.com/page-2", "status": "completed" }
    ]
  }
}

Verificar Saldo#

GET/api/v1/balance30 ped / 60s

Verifica o teu saldo de créditos atual.

Exemplo de Pedido

cURL

curl https://indexbolt.com/api/v1/balance \
  -H "Authorization: Bearer ib_your_api_key"

Resposta — 200 OK

{
  "success": true,
  "data": {
    "balance": 98,
    "unit": "credits"
  }
}

Pronto para começar?

Cria uma conta, obtém a tua chave API e começa a indexar URLs em minutos.

Começar Grátis Gerir Chaves API