Справочник API индексации в Google

Быстрый старт

1. Получите ключ. Откройте @IndexForgeBot и нажмите 🔑 API. Ключ показывается один раз, сохраните его.
2. Отправьте адреса. POST /v1/submit с JSON-массивом до 10 000 адресов. Идентификатор задачи приходит сразу.
3. Опрашивайте задачу. GET /v1/tasks/{id} примерно раз в 10 секунд, пока статус не станет done, partial или failed.
4. Заберите результат. Принято, отсеяно с причинами, списано и возвращено, всё в одном объекте.

$ curl -X POST https://api.indexforge.help/v1/submit \
  -H "Authorization: Bearer YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls": [
        "https://site.com/page-1",
        "https://site.com/page-2"]}'

import requests, time

API = "https://api.indexforge.help"
H = {"Authorization": "Bearer YOUR_KEY"}

task = requests.post(API + "/v1/submit", headers=H, json={"urls": urls}).json()["task"]
while task["status"] in ("queued", "checking", "submitting"):
    time.sleep(10)
    task = requests.get(API + "/v1/tasks/" + task["id"], headers=H).json()["task"]
print(task["accepted"], "принято", task.get("rejected", 0), "отсеяно")

const API = "https://api.indexforge.help";
const H = { Authorization: "Bearer YOUR_KEY", "Content-Type": "application/json" };

let { task } = await (await fetch(API + "/v1/submit", {
  method: "POST", headers: H, body: JSON.stringify({ urls })
})).json();
while (["queued", "checking", "submitting"].includes(task.status)) {
  await new Promise(r => setTimeout(r, 10000));
  ({ task } = await (await fetch(API + "/v1/tasks/" + task.id, { headers: H })).json());
}
console.log(task.accepted, "принято");

$ch = curl_init("https://api.indexforge.help/v1/submit");
curl_setopt_array($ch, [
  CURLOPT_POST => true,
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ["Authorization: Bearer YOUR_KEY", "Content-Type: application/json"],
  CURLOPT_POSTFIELDS => json_encode(["urls" => $urls]),
]);
$task = json_decode(curl_exec($ch), true)["task"];

202 Accepted · 184 ms # 202 · задача создана
{ "ok": true,
  "task": { "id": "3f9c2a7d1b6e4c80",
            "status": "queued", "urls": 2 } }

Базовый адрес и авторизация

Все запросы идут на https://api.indexforge.help. Тела запросов и ответы в JSON, кодировка UTF-8, в каждом ответе есть поле ok.

Ключ передаётся в одном из заголовков:

Authorization: Bearer YOUR_KEY
X-API-Key: YOUR_KEY

• Ключ выдаёт бот по кнопке 🔑 API и показывает один раз. Храните его как пароль.
• Новый ключ сразу отключает старый. Так и поступайте, если ключ утёк.
• Баланс у API и бота общий: пополняете в боте, тратите где удобно.

POST /v1/submit

Создаёт задачу: проверяет адреса так, как их видит Googlebot, и отправляет прошедшие на индексацию.

{ "urls": ["https://site.com/page-1", "https://site.com/page-2"], "check": true }

Ответ 202 Accepted с новой задачей:

{ "ok": true,
  "task": { "id": "3f9c2a7d1b6e4c80", "status": "queued",
            "created": 1760263200, "urls": 2 } }

GET /v1/tasks/{id}

Статус и счётчики одной задачи. Задачу видит только владелец ключа.

{ "ok": true, "task": {
  "id": "3f9c2a7d1b6e4c80", "status": "done",
  "created": 1760263200, "finished": 1760263295,
  "urls": 3, "checked": 3, "rejected": 1,
  "rejected_urls": { "404": ["https://site.com/old"] },
  "accepted": 2, "charged": 2, "refunded": 0 } }

Причины в rejected_urls:

GET /v1/tasks

Последние задачи, от новых к старым. Необязательный limit от 1 до 100, по умолчанию 20.

GET /v1/tasks?limit=20

{ "ok": true, "tasks": [ { "id": "3f9c2a7d1b6e4c80", "status": "done", … }, … ] }

GET /v1/balance

Остаток кредитов и текущая цена.

{ "ok": true, "balance": 1250, "unlimited": false, "price_per_url_usd": 0.01 }

Статусы задачи

Завершённая задача получает один из трёх статусов:

• done: принято всё, что прошло проверку. Если не прошло ничего, задача тоже done с accepted: 0 и без списаний.
• partial: принята часть, кредиты за остальное возвращены.
• failed: ничего не отправлено, зарезервированные кредиты возвращены.

Поле error объясняет результат partial или failed:

Ошибки

Ошибки приходят с HTTP-кодом и JSON-телом, чтобы ваш код отличал кривой запрос от пустого баланса:

{ "ok": false, "error": "insufficient_credits", "message": "Balance is 0. Top up in the bot." }

Лимиты

Индексация обычно занимает 1–3 дня после завершения задачи. Цена: $0.01 за принятый адрес, как и в боте.

Вопросы про API