Documentação da API IndexJump
Integre a indexação rápida ao seu fluxo de trabalho com nossa poderosa API REST
IndexJump fornece serviços de indexação rápida para Google, Bing e outros mecanismos de pesquisa. A API é acessível por meio de quatro endpoints, permitindo gerenciar sua fila de indexação e monitorar o progresso em tempo real.
Autenticação
Todas as solicitações de API requerem um parâmetro «token» para autenticação. Inclua seu token de API em cada solicitação como parâmetro de consulta ou no corpo da solicitação.
Seu token é exclusivo da sua conta e deve ser mantido confidencial. Nunca compartilhe-o publicamente ou submeta-o ao controle de versão.
Faça login ou crie uma conta para visualizar seu token de API.
ComeceTerminais de API
Obtenha equilíbrio
https://api.indexjump.com/balanceRecupere o número de URLs disponíveis em sua conta para indexação.
Parâmetros
token | Obrigatório | Seu token de autenticação de API |
Exemplo de solicitação
curl -X GET "https://api.indexjump.com/balance?token=YOUR_TOKEN"Resposta de sucesso (200)
{
"err": null,
"res": {
"balance": 74
}
}Enviar URL para indexação
https://api.indexjump.com/indexEnvie um único URL para ser indexado pelos motores de busca.
Parâmetros
url | Obrigatório | O URL a ser indexado |
token | Obrigatório | Seu token de autenticação de API |
bot | Opcional | Alvo do mecanismo de pesquisa: 0 (GoogleBot), 1 (OpenAIBot), 2 (BingBot). Padrão: 0 |
Exemplo de solicitação
curl -X GET "https://api.indexjump.com/index?url=https%3A%2F%2Fexample.com&token=YOUR_TOKEN"Resposta de sucesso (200)
{
"err": null,
"res": {
"success": true
}
}Envio em massa de URLs para indexação
https://api.indexjump.com/index/bulkEnvie vários URLs em uma única solicitação para indexação em lote.
Cabeçalhos
Content-Type | application/json |
Parâmetros corporais
urls | Obrigatório | Matriz de URLs a serem indexados |
token | Obrigatório | Seu token de autenticação de API |
bot | Opcional | Alvo do mecanismo de pesquisa: 0 (GoogleBot), 1 (OpenAIBot), 2 (BingBot). Padrão: 0 |
Exemplo de solicitação
curl -X POST "https://api.indexjump.com/index/bulk?token=YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"urls": [
"https://example1.com",
"https://example2.com"
]
}'Resposta de sucesso (200)
{
"err": null,
"res": {
"success": true
}
}Verifique o status da indexação
https://api.indexjump.com/index/statusVerifique o status atual da indexação e visualize os logs do rastreador para um URL enviado.
Parâmetros
url | Obrigatório | O URL para verificar o status de indexação |
token | Obrigatório | Seu token de autenticação de API |
bot | Opcional | Alvo do mecanismo de pesquisa: 0 (GoogleBot), 1 (OpenAIBot), 2 (BingBot). Padrão: 0 |
Exemplo de solicitação
curl -X GET "https://api.indexjump.com/index/status?url=https%3A%2F%2Fexample.com&token=YOUR_TOKEN"Resposta de sucesso (200)
{
"err": null,
"res": {
"success": true,
"status": "Delivered",
"log_visit": "September 3, 2024, 11:25 am (UTC +0) --- GET --- 66.249.78.3"
}
}Valores de status
- Delivered - O bot foi entregue; URL será indexado em breve
- In progress - Entrega do bot em andamento
- In queue - URL na fila para entrega de bot
- Not found - URL não encontrado em sua conta
Códigos de status HTTP
OK
Solicitação bem-sucedida
Pedido ruim
Parâmetros inválidos ou solicitação malformada
Não autorizado
Token de API ausente ou inválido
Muitas solicitações
Limite de taxa excedido. Por favor, tente novamente após atraso
Perguntas frequentes sobre APIs
Existe um limite de taxa?
Sim, os endpoints da API têm limites de taxa para garantir um uso justo. Os limites padrão são 100 solicitações por minuto por token. Entre em contato com o suporte para limites mais altos.
Quanto tempo até que um URL seja indexado?
Após o envio, os bots dos mecanismos de pesquisa normalmente visitam o site dentro de 24 a 48 horas. A indexação final no índice primário leva em média de 1 a 3 semanas, dependendo da qualidade do conteúdo e da autoridade do site.
Posso usar a API com webhooks?
Atualmente, a API não oferece suporte a webhooks. Use o endpoint de status para pesquisar atualizações ou verificar seu painel para monitoramento em tempo real.
O que acontece se um URL falhar?
Se a indexação falhar, verifique o endpoint de status para obter informações detalhadas sobre o erro. Problemas comuns incluem URLs inválidos, diretivas noindex ou erros de servidor. Nossa equipe de suporte pode ajudar a diagnosticar problemas.
O acesso à API está disponível em planos gratuitos?
Sim, o acesso à API está incluído no plano gratuito. O plano gratuito inclui 100 URLs para indexação.
Como lidar com erros?
Todas as respostas incluem um campo «err». Se «err» for nulo, a solicitação foi bem-sucedida. Caso contrário, verifique a mensagem de erro para obter detalhes e tente novamente de forma adequada.
Pronto para automatizar sua indexação?
Comece a usar a API hoje mesmo com sua avaliação gratuita de 100 URLs. Não é necessário cartão de crédito.
Obtenha seu token de API