Link Indexing Bot API
Данное API позволяет отправлять ссылки на индексацию программно без взаимодействия с телеграм-ботом.
Для использования API вам потребуется создать API-ключ. Начните чат с ботом https://t.me/Link_Indexing_bot и введите команду /apikey для создания или обновления ключа. Не забудьте пополнить счет - при отправке ссылок на индексацию расходуются лимиты.
При отправке POST тело запроса может быть в JSON, FormData, URLEncodedForm. Если вы получаете ошибку об отсутствии API_KEY хотя он есть в теле, значит тело отправляется неверно и не может быть прочитано сервером.
Отправка на индексацию (Создать задачу)
Для создания задачи совершите POST запрос на URL:
https://link-indexing-bot.ru/api/tasks/new
Тело запроса
| Поле | Обязательный? | Описание |
|---|---|---|
| api_key | да | Ваш ключ для доступа к API |
| user_id | да | ID пользователя в телеграме (можно узнать командой /help в боте) |
| links | да | Список ссылок для индексации, каждая в новой строке (\n), макс. длина ссылки 2000 символов. |
| searchengine | да | Поисковая система: google, yandex или bing |
| se_type | да | Способ индексации: normal или hard |
Пример успешного запроса:
Тело запроса в JSON формате:
{
"api_key":"fef34frgad2f4th56heg4fsdfa3f4gthyf3wf3trfgs",
"user_id":"666666666",
"links":"https://google.com\nhttps://bing.com",
"searchengine":"google",
"se_type":"normal"
}
Ответ сервера:
{
"status": 201,
"msg": "Задача успешно создана",
"data": {
"limits_used": 4,
"task_id": "32451",
"links_count": 2,
"not_valid_count": 0,
"not_valid_links": []
}
}
Информация о задаче
Для просмотра статуса задачи совершите GET запрос на URL:
https://link-indexing-bot.ru/api/tasks/{id}
Вместо {id} укажите номер задачи, полученный при ее создании через /tasks/new
Тело запроса
| Поле | Обязательный? | Описание |
|---|---|---|
| api_key | да | Ваш ключ для доступа к API |
| user_id | да | ID пользователя в телеграме (можно узнать командой /help в боте) |
Остаток на балансе
Для просмотра информации о юзере и остатке лимитов совершите GET запрос на URL:
https://link-indexing-bot.ru/api/users/{id}
Вместо {id} укажите ID пользователя в телеграме (можно узнать командой /help в боте)
Тело запроса
| Поле | Обязательный? | Описание |
|---|---|---|
| api_key | да | Ваш ключ для доступа к API |
Ошибки
При неправильно сформированном запросе сервер может ответить одной из ошибок:
| Код ошибки | Описание |
|---|---|
| 400 | Ошибка при создании задачи. Скорей всего неправильно оформленный запрос. |
| 403 |
Неверный или отсутствующий ключ API.
|
| 404 | Не найдена информация удовлетворяющая запросу (задача с таким ID не существует). |
| 503 | Скорей всего возникла ошибка на стороне сервера при отправке ссылок на индексацию. |
Пример ошибки
URL:
https://link-indexing-bot.ru/api/tasks/new
Тело запроса в JSON формате:
{
"api_key":"fef34frgad2f4th56heg4fsdfa3f4gthyf3wf3trfgs",
"user_id":"666666666",
"links":"https://google.com\nhttps://bing.com",
"se_type":"normal"
}
Ответ сервера:
{
"status":400,
"msg":"Task wasn't created: Invalid data provided",
"data":[]
}
В этом примере отсутствует обязательный параметр searchengine.