Документація та гайди

Як це працює

1. Ваш сервер надсилає до IndexLaunch список URL сторінок, підписаний вашим API-ключем.
2. IndexLaunch перевіряє кожен URL, списує по одному кредиту за URL і надсилає його пошуковим системам на сканування. У відповідь ви отримуєте по одному ID для кожного URL.
3. За цими ID можна будь-коли перевірити статус кожного URL.

Налаштування за 4 кроки

1. Увійдіть і створіть ключ у розділі Налаштування → Доступ до API. Він показується лише один раз, тож одразу скопіюйте його.
2. Збережіть ключ як секретну змінну середовища на сервері або в CI, наприклад INDEXLAUNCH_API_KEY. Ніколи не розміщуйте його в браузерному коді чи публічному репозиторії.
3. Підтвердьте кожен домен, URL якого надсилатимете (Settings → Domain Verification). Пошукові системи відхиляють URL непідтверджених сайтів.
4. Викликайте API зі свого бекенду, скрипта або конвеєра деплою. Приклади нижче готові до копіювання.

Автентифікація

Передавайте ключ у заголовку Authorization кожного запиту у вигляді Bearer YOUR_KEY. Усі запити використовують HTTPS і JSON.

Authorization: Bearer il_live_xxxxxxxxxxxxxxxxxxxxxxxx

Надсилання URL

Надсилайте до 500 повних URL (що починаються з https://) за один запит. Кожен URL коштує один кредит. Відповідь містить по одному ID для кожного URL у тому самому порядку, у якому ви їх надіслали.

POST https://www.indexlaunch.site/api/v1/submit
Authorization: Bearer il_live_xxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

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

200 OK
{ "submitted": 2, "ids": ["j57...", "j58..."] }

Перевірка статусу URL

Передайте ID з відповіді на надсилання. Ви можете переглядати лише URL, надіслані з вашого облікового запису.

GET https://www.indexlaunch.site/api/v1/urls/j57...
Authorization: Bearer il_live_xxxxxxxxxxxxxxxxxxxxxxxx

200 OK
{
  "id": "j57...",
  "url": "https://example.com/page-1",
  "status": "indexed",
  "submittedAt": 1757740800000,
  "indexedAt": 1757741100000
}

Поля відповіді

id

ID надсилання.

url

Надісланий вами URL.

status

Одне зі значень статусу нижче.

submittedAt

Час надсилання в мілісекундах від початку епохи Unix.

indexedAt

Час, коли пошукові системи прийняли URL. До цього моменту відсутнє.

Значення статусу

pending

Отримано й очікує надсилання. Більшість URL проходять далі протягом кількох хвилин.

indexed

Прийнято пошуковими системами й поставлено в чергу на сканування. У панелі керування відображається як «Submitted». Це ще не підтверджує, що сторінку проіндексовано.

failed

Пошукові системи не прийняли URL — найчастіше тому, що домен не підтверджено. Кредит повертається автоматично.

refunded

URL застряг понад 7 днів, тому кредит було повернено автоматично.

Приклади коду

curl -X POST https://www.indexlaunch.site/api/v1/submit \
  -H "Authorization: Bearer $INDEXLAUNCH_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"urls": ["https://example.com/new-post"]}'

const res = await fetch("https://www.indexlaunch.site/api/v1/submit", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.INDEXLAUNCH_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    urls: ["https://example.com/new-post", "https://example.com/pricing"],
  }),
});

const data = await res.json();
if (!res.ok) throw new Error(data.error);
console.log(`Submitted ${data.submitted} URLs`, data.ids);

import os
import requests

res = requests.post(
    "https://www.indexlaunch.site/api/v1/submit",
    headers={"Authorization": f"Bearer {os.environ['INDEXLAUNCH_API_KEY']}"},
    json={"urls": ["https://example.com/new-post"]},
    timeout=30,
)
data = res.json()
if not res.ok:
    raise RuntimeError(data["error"])
print(data["submitted"], data["ids"])

# .github/workflows/indexlaunch.yml
name: Submit new pages
on:
  workflow_dispatch:
  push:
    branches: [main]

jobs:
  submit:
    runs-on: ubuntu-latest
    steps:
      - name: Send changed URLs to IndexLaunch
        env:
          INDEXLAUNCH_API_KEY: ${{ secrets.INDEXLAUNCH_API_KEY }}
        run: |
          curl --fail-with-body -X POST https://www.indexlaunch.site/api/v1/submit \
            -H "Authorization: Bearer $INDEXLAUNCH_API_KEY" \
            -H "Content-Type: application/json" \
            -d '{"urls": ["https://example.com/new-post"]}'

Помилки

У разі помилки повертається JSON із полем error, що містить повідомлення, яке можна показати або записати в журнал.

400

Неправильний запит: у тілі немає списку urls, якийсь URL недійсний, надіслано понад 500 URL, недостатньо кредитів або запити надходять надто часто.

401

Ключ відсутній, неправильний або відкликаний.

403

Обліковий запис заблоковано.

404

У вашому обліковому записі немає надсилання з таким ID.

Рекомендації

• Надсилайте лише нові або змінені сторінки, а не весь сайт під час кожного деплою.
• Об'єднуйте URL в один запит замість окремого запиту для кожного URL.
• Якщо ви отримали «Too many requests» або повідомлення про перевищення ліміту, зачекайте хвилину й повторіть спробу. Точні ліміти вашого облікового запису вказано в розділі Налаштування → Доступ до API.
• Якщо ключ потрапив у чужі руки, відкличте його в налаштуваннях і створіть новий. Відкликані ключі одразу перестають працювати.