开发者资源

REST API 参考

将批量收录查询直接集成到你自己的面板、工具或脚本中。用我们的高吞吐量 API 实现 SEO 工作流自动化。

简而言之

借助 IndexChecker REST API，你可以在自己的脚本和面板中创建查询项目、读取收录状态并查询积分余额。每个请求都通过 POST 正文中的私密 API 密钥进行认证，端点返回 JSON，一个项目最多可容纳 50,000 个 URL，1 个积分查询 1 个 URL。

作者：Adam Piersa，IndexChecker 创始人 审核并更新于

IndexChecker API 有哪些端点？

端点方法用途
/api/project/createPOST根据 URL 列表创建查询项目
/api/project/showPOST获取项目的状态、统计数据和链接
/api/project/show_allPOST列出你的所有项目
/api/project/deletePOST永久删除项目
/api/check-balancePOST读取当前积分余额

认证

在请求正文（POST 参数）中包含你的私密 API 密钥来认证请求。

你可以在控制面板设置中查找和管理 API 密钥。

安全提示：请妥善保管你的 API 密钥。不要在公开可访问的代码（例如客户端 JS）中分享它。

POST

创建项目

用 URL 列表创建新的查询项目。

https://app.indexchecker.link/api/project/create
apikey 必填 string

你的私密 API 密钥。

project_name 必填 string

项目名称。

urls 必填 string

用竖线符号 | 分隔的 URL 列表。

description 可选 string
cURL 示例 POST
curl -X POST https://app.indexchecker.link/api/project/create \
  -d "apikey=YOUR_API_KEY" \
  -d "project_name=MyProject" \
  -d "urls=https://site1.com|https://site2.com"
响应 200 OK
{
  "error": 0,
  "message": "project MyProject has been added in it 2 links.",
  "project_name": "MyProject",
  "procjet_id": 154,
  "project_id": 154,
  "add_links_count": 2
}
POST

获取项目详情

获取指定项目的状态、统计数据和链接。

https://app.indexchecker.link/api/project/show
apikey 必填
project_id 必填 int

要获取的项目 ID。

响应 200 OK
{
  "project_name": "MyProject",
  "description": "optional description",
  "date_created": "2023-10-12 14:30:00",
  "project_id": "154",
  "urls": {
    "https://site1.com": "1",
    "https://site2.com": "-1"
  },
  "statistics": {
    "total_links": 2,
    "indexed": 1,
    "not_indexed": 0,
    "pending": 1,
    "percentage": 50
  }
}
* 状态码：1（已收录），0（未收录），-1（等待查询）
POST

列出所有项目

获取你所有项目的列表。

https://app.indexchecker.link/api/project/show_all
apikey 必填
响应
{
  "154": {
    "project_name": "MyProject",
    "description": "",
    "date_created": "2023-10-12 14:30:00"
  },
  "155": {
    "project_name": "Another Project",
    "description": "SEO Audit",
    "date_created": "2023-10-13 09:15:00"
  }
}
POST

删除项目

永久删除项目及所有相关数据。

https://app.indexchecker.link/api/project/delete
apikey 必填
project_id 必填

要删除的项目 ID。

响应
{
  "id": "154",
  "error": 0,
  "message": "The MyProject project has been deleted"
}
POST

查询余额

获取你当前的积分额度。

https://app.indexchecker.link/api/check-balance
apikey 必填
响应 200 OK
{
  "limit": 4500,
  "error": 0
}

常见问题

如何认证 API 请求？

在每个请求的 POST 正文中以 apikey 参数包含你的私密 API 密钥。你可以在控制面板设置中查找和管理密钥。

一个 API 项目最多可以包含多少个 URL？

每个项目最多 50,000 个 URL，与控制面板的上限相同。创建项目时，在 urls 参数中用竖线符号分隔它们。

通过 API 查询要花多少钱？

每查询一个 URL 花 1 个积分，包括在第二个数据中心的复查。积分永不过期，从免费试用开始的每个套餐都包含 API 访问。

API 以什么格式返回？

JSON。每个端点都会返回一个 error 字段（成功时为 0），以及项目数据：状态、统计信息，以及在适用时每个 URL 的收录结果。

IndexChecker 是一款 Google 批量收录查询工具，由 AP2Media Sp. z o.o. 运营，这是一家总部位于波兰 Czerwin 的欧盟注册公司（增值税号 PL7582396091）。它在公司自己的 SEO 项目中实际投入使用，包括本地 SEO 服务 drukujemy3d.pl，并在过去 30 天内为客户验证了超过两百万个 URL。

资料来源与参考

Google 关于收录原理及如何查询收录的官方文档。