IndexJump API 文档
使用我们强大的 REST API 将快速索引集成到您的工作流程中
IndexJump 为 Google、Bing 和其他搜索引擎提供快速索引服务。该 API 可通过四个端点访问，允许您管理索引队列并实时监控进度。
验证
所有 API 请求都需要一个“token”参数进行身份验证。在每个请求中或在请求正文中包含您的 API 令牌作为查询参数。
您的令牌对于您的帐户来说是唯一的，应该保密。切勿公开共享它或将其提交给版本控制。
登录或创建帐户以查看您的 API 令牌。
开始使用API端点
GET
获得平衡
https://api.indexjump.com/balance检索您帐户中可用于索引的 URL 数量。
参数
token | 必需的 | 您的 API 身份验证令牌 |
请求示例
curl -X GET "https://api.indexjump.com/balance?token=YOUR_TOKEN"成功响应 (200)
{
"err": null,
"res": {
"balance": 74
}
}POST
提交用于索引的 URL
https://api.indexjump.com/index提交单个 URL 以供搜索引擎索引。
参数
url | 必需的 | 要索引的 URL |
token | 必需的 | 您的 API 身份验证令牌 |
bot | 选修的 | 搜索引擎目标：0 (GoogleBot)、1 (OpenAIBot)、2 (BingBot)。默认值：0 |
请求示例
curl -X GET "https://api.indexjump.com/index?url=https%3A%2F%2Fexample.com&token=YOUR_TOKEN"成功响应 (200)
{
"err": null,
"res": {
"success": true
}
}POST
批量提交 URL 以进行索引
https://api.indexjump.com/index/bulk在单个请求中提交多个 URL 以进行批量索引。
标头
Content-Type | application/json |
机身参数
urls | 必需的 | 要索引的 URL 数组 |
token | 必需的 | 您的 API 身份验证令牌 |
bot | 选修的 | 搜索引擎目标：0 (GoogleBot)、1 (OpenAIBot)、2 (BingBot)。默认值：0 |
请求示例
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"
]
}'成功响应 (200)
{
"err": null,
"res": {
"success": true
}
}GET
检查索引状态
https://api.indexjump.com/index/status检查当前索引状态并查看已提交 URL 的爬网程序日志。
参数
url | 必需的 | 用于检查索引状态的 URL |
token | 必需的 | 您的 API 身份验证令牌 |
bot | 选修的 | 搜索引擎目标：0 (GoogleBot)、1 (OpenAIBot)、2 (BingBot)。默认值：0 |
请求示例
curl -X GET "https://api.indexjump.com/index/status?url=https%3A%2F%2Fexample.com&token=YOUR_TOKEN"成功响应 (200)
{
"err": null,
"res": {
"success": true,
"status": "Delivered",
"log_visit": "September 3, 2024, 11:25 am (UTC +0) --- GET --- 66.249.78.3"
}
}状态值
- Delivered - 机器人已交付；网址很快就会被索引
- In progress - 机器人交付正在进行中
- In queue - URL 已排队等候机器人传送
- Not found - 在您的帐户中找不到网址
HTTP 状态代码
200
好的
请求成功
400
错误的请求
无效参数或格式错误的请求
401
未经授权
API 令牌缺失或无效
429
请求过多
超出速率限制。请延迟后重试
API常见问题解答
有速率限制吗？
是的，API 端点有速率限制以确保公平使用。标准限制是每个令牌每分钟 100 个请求。请联系支持人员以获取更高的限制。
URL 被索引需要多长时间？
提交后，搜索引擎机器人通常会在 24-48 小时内访问。主索引中的最终索引平均需要 1-3 周，具体取决于内容质量和网站权威。
我可以将 API 与 webhook 一起使用吗？
目前，该 API 不支持 webhook。使用状态端点轮询更新或检查仪表板以进行实时监控。
如果 URL 失败会发生什么？
如果索引失败，请检查状态端点以获取详细的错误信息。常见问题包括无效 URL、noindex 指令或服务器错误。我们的支持团队可以帮助诊断问题。
免费计划是否提供 API 访问？
是的，API 访问包含在免费计划中。免费计划包括 100 个用于索引的 URL。
我如何处理错误？
所有响应都包含“err”字段。如果“err”为空，则请求成功。否则，请检查错误消息的详细信息并适当重试。
