Документація 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 - Бот доставлено; URL незабаром буде проіндексовано
  • In progress - Зараз виконується доставка бота
  • In queue - URL-адреса в черзі для доставки роботом
  • Not found - URL не знайдено у вашому обліковому записі

Коди стану HTTP

200

Добре

Запит виконано

400

Поганий запит

Недійсні параметри або неправильно сформований запит

401

Несанкціонований

Відсутній або недійсний маркер API

429

Забагато запитів

Ліміт швидкості перевищено. Повторіть спробу після затримки

API FAQ

Чи є обмеження по ставці?

Так, кінцеві точки API мають обмеження на швидкість, щоб забезпечити чесне використання. Стандартні обмеження становлять 100 запитів на хвилину на токен. Щоб отримати вищі ліміти, зверніться до служби підтримки.

Через який час URL буде проіндексовано?

Після надсилання роботи пошукових систем зазвичай відвідують протягом 24-48 годин. Остаточна індексація в основному індексі займає в середньому 1-3 тижні, залежно від якості вмісту та авторитету сайту.

Чи можу я використовувати API з веб-хуками?

Наразі API не підтримує вебхуки. Використовуйте кінцеву точку стану, щоб запитувати оновлення або перевіряти свою інформаційну панель для моніторингу в реальному часі.

Що станеться, якщо URL не вдасться?

Якщо індексування не вдається, перевірте стан кінцевої точки для отримання детальної інформації про помилку. До поширених проблем належать недійсні URL-адреси, директиви noindex або помилки сервера. Наша служба підтримки може допомогти діагностувати проблеми.

Чи доступ до API доступний у безкоштовних планах?

Так, доступ до API включено в безкоштовний план. Безкоштовний план включає 100 URL-адрес для індексації.

Як обробляти помилки?

Усі відповіді містять поле "err". Якщо "err" дорівнює нулю, запит виконано успішно. В іншому випадку перевірте повідомлення про помилку, щоб отримати деталі, і повторіть відповідну спробу.

Готові автоматизувати індексацію?

Почніть використовувати API вже сьогодні з безкоштовною пробною версією 100 URL-адрес. Кредитна картка не потрібна.

Отримайте свій маркер API