Документация API IndexJump

Интегрируйте быструю индексацию в свой рабочий процесс с помощью нашего мощного 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

Есть ли ограничение по скорости?

Да, конечные точки API имеют ограничения по скорости для обеспечения справедливого использования. Стандартные ограничения — 100 запросов в минуту на один токен. Свяжитесь со службой поддержки для получения более высоких лимитов.

Как долго URL будет проиндексирован?

После отправки боты поисковых систем обычно посещают вас в течение 24–48 часов. Окончательная индексация в первичном индексе занимает в среднем 1-3 недели, в зависимости от качества контента и авторитетности сайта.

Могу ли я использовать API с веб-перехватчиками?

В настоящее время API не поддерживает веб-перехватчики. Используйте конечную точку статуса для опроса обновлений или проверки панели мониторинга для мониторинга в режиме реального времени.

Что произойдет, если URL-адрес не удастся?

Если индексирование не удалось, проверьте конечную точку состояния для получения подробной информации об ошибке. Общие проблемы включают неверные URL-адреса, директивы noindex или ошибки сервера. Наша служба поддержки может помочь диагностировать проблемы.

Доступен ли доступ к API в бесплатных планах?

Да, доступ к API включен в бесплатный план. Бесплатный план включает 100 URL-адресов для индексации.

Как обрабатывать ошибки?

Все ответы содержат поле «err». Если «err» имеет значение null, запрос выполнен успешно. В противном случае проверьте сообщение об ошибке и повторите попытку соответствующим образом.

Готовы автоматизировать индексирование?

Начните использовать API сегодня, получив бесплатную пробную версию из 100 URL-адресов. Кредитная карта не требуется.

Получите свой токен API