API сервиса поиска битых ссылок Badlinks.ru
Badlinks.ru — сервис поиска битых ссылок. Мы помогаем делать сайты лучше и, конечно, рады когда кто-то разделяет наше устремление.
Мы подготовили полноценный интерфейс, позволяющий разместить наш функционал на любом сайте. У Вас есть сайт для веб-мастеров или оптимизаторов, сервис проверки позиций сайта или анализа сайтов? Отлично, с нашим функционалом Вы легко сможете сделать его более информативным.
Мы предлагаем два варианта интеграции:
- Простое решение — не требует опыта в программировании и занимает всего несколько минут. Оно отлично подходит для сервисов анализа сайтов. Достаточно установить на странице проверки сайта iframe с адресом https://api.badlinks.ru/pinch/iframe/{domain}, заменив {domain} на адрес проверяемого сайта, все остальное наш сервис сделает автоматически. Рекомендованный размер iframe - не менее 900х400px.
-
Комплексное решение — полноценное REST API, позволяющее создавать проверки, получать информацию об их ходе и результатах.
Этот вариант более гибок, однако более сложен в интеграции.
Обязательным условием использорвания REST API является ссылка "Проверьте сайт полностью", расположенная рядом с результатами поиска и ведущая на адрес https://badlinks.ru#domain=ххххх.ru, где ххххх.ru — адрес проверяемого сайта. Ссылка может быть закрыта от индексации поисковыми роботами.
Для получения реквизитов доступа напишите, пожалуйста, письмо в произвольной форме на адрес support@badlinks.ru.
Оба варианта интеграции предполагают лимит на 10 проверяемых страниц и полностью бесплатны. Проверка занимает от нескольких секунд до пары минут — в зависимости от размера проверяемого сайта. Кроме того, действует ограничение на 3 проверки одного домена в течение часа и на две одновременные проверки одного сайта. Мы не накладываем никаких иных ограничений на использование API, однако, в случае неоднократных недружественных действий (флуд, автоматическая генерация множества запросов) мы оставляем за собой право прекратить доступ к API.
Помимо этого, мы приветствуем любые варианты сотрудничества, включая расширенное API с доступом ко всем возможностям системы (и вычислительным мощностям, позволяющим проверять более 1Млн страниц в день), что может быть полезно крупным SEO-оптимизаторам, а также возможность установки отдельной копии нашего программного обеспечения для постоянного мониторинга крупных и очень крупных проектов.
Описание API
Все обращения к API отправляются при помощи POST-запросов на соответсвующий адрес.
В каждом запросе необходимо указывать Ваш код доступа, который мы предоставляем по запросу. Также возможно (и крайне желательно) сообщить нам
IP-адрес сервера, с которого отправляются запросы, для обеспечения дополнительной безопасности. Кодировка запросов и ответов сервера — UTF-8.
Результаты проверок, создаваемых через API, хранятся на нашем сервере в течение одного часа.
Ответ возвращается в виде json-кодированного массива данных. Структура данных:
{
"code":200,
"message":"OK",
"data":{}
}
где:
- code: код ответа. Может принимать заничения: 200 при успешном выполнении запроса и 5XX в случае ошибки
- message: текст сообщения об ошибке
- data: массив данных, отличается для каждого типа запроса
Виды запросов:
- Создание новой проверки:
Для создания новой проверки сайта отправьте POST-запрос на адрес:
https://api.badlinks.ru/pinch/add/?auth=login&host=xxxxx.ru
где login - код доступа, а xxxxx.ru — адрес проверяемого сайта
Возвращаемые данные в случае успешного запроса
{ "code":200, "message":"OK", "data":{ "host":"xxxxx.ru", "hash":"12345678" } }где:- host: адрес проверяемого сайта
- hash: уникальный код проверки, который будет необходим для дальнейших запросов
- Получение статуса проверки:
Мы рекомендуем выполнять этот запрос циклично до окончания проверки:
https://api.badlinks.ru/pinch/status/?auth=login&hash=12345678
где login - код доступа, а 12345678 — код проверки, полученный при ее создании
Возвращаемые данные в случае успешного запроса
{ "code":200, "message":"OK", "data":{ "finished":0, "progress":53, "page_found":"100", "page_passed":"6", "skipped_found":90, "skipped_passed":"30", "file_found":50, "file_passed":35, "external_found":"15", "external_passed":"10", "errors":"5", "last_pages":[ { "id":"265", "scheme":"http", "host":"xxxxx.ru", "url":"\/about\/", "linktext":"О нас", "title":"О компании" "referer":"xxxxx.cz\/", }, ... ], "badlinks":[ { "id":"1", "referer":"xxxxx.ru\/", "errors":[ { "id":"1", "host":"xxxxx.ru", "url":"\/about\/something\/", "linktext":"Что-то еще"}, ] } ], "host":"xxxxx.ru", "hash":"12345678" } }где:- finished: окончена проверка или нет, возвращаемые значения 1 и 0 соответственно
- progress: прогресс выполения проверки в процентах
- page_found: количество найденых страниц на сайте
- page_passed: количество проверенных страниц
- skipped_found: сколько страниц найдено сверх проверяемого лимита в 10 страниц
- skipped_passed: сколько страниц, из найденных сверх лимита, существует
- file_found: сколько файлов (изображений, .css и .js файлов, а также ссылок на любые иные файлы) найдено
- file_passed: сколько файлов проверено
- external_found: сколько внешних ссылок найдено
- file_passed: сколько внешних ссылок проверено
- errors: количество найденных битых ссылок
- last_pages: последние 4 проверенные страницы, для каждой отображается:
- id: уникальный в рамках проверки идентификатор
- scheme: протокол сайта, HTTP или HTTPS
- host: сайт, к которому относится ссылка
- url: относительный путь к странице
- linktext: текст ссылки, приведшей на данную страницу
- title: заголовок страницы
- referer: с какой страницы вела ссылка на данную страницу
- badlinks: найденные битые ссылки:
- id: идентификатор страницы, на которой обнаружена битая ссылка
- referer: адрес страницы, на которой обнаружена битая ссылка
- errors: список битых сслок для данной страницы:
- id: уникальный в рамках проверки идентификатор
- host: сайт, к которому относится ссылка
- url: относительный адрес битой ссылки
- linktext: текст битой ссылки
- host: адрес проверяемого сайта
- hash: уникальный код проверки, который будет необходим для дальнейших запросов
- Получение результатат проверки:
Запрос на получение финальных данных по проверке, возвращающий, в отличие от предыдущего запроса, полный список проверенных страниц:
https://api.badlinks.ru/pinch/result/?auth=login&hash=12345678
где login - код доступа, а 12345678 — код проверки, полученный при ее создании
Возвращаемые данные в случае успешного запроса
{ "code":200, "message":"OK", "data":{ "page_found":"100", "page_passed":"10", "skipped_found":90, "skipped_passed":"90", "file_found":50, "file_passed":50, "external_found":"15", "external_passed":"15", "errors":"7", "last_pages":[ { "id":"265", "scheme":"http", "host":"xxxxx.ru", "url":"\/about\/", "linktext":"О нас", "title":"О компании" "referer":"xxxxx.cz\/", }, ... ], "badlinks":[ { "id":"1", "referer":"xxxxx.ru\/", "errors":[ { "id":"1", "host":"xxxxx.ru", "url":"\/about\/something\/", "linktext":"Что-то еще"}, ] } ], "host":"xxxxx.ru", "hash":"12345678" } }где:- page_found: количество найденых страниц на сайте
- page_passed: количество проверенных страниц
- skipped_found: сколько страниц найдено сверх проверяемого лимита в 10 страниц
- skipped_passed: сколько страниц, из найденных сверх лимита, существует
- file_found: сколько файлов (изображений, .css и .js файлов, а также ссылок на любые иные файлы) найдено
- file_passed: сколько файлов проверено
- external_found: сколько внешних ссылок найдено
- file_passed: сколько внешних ссылок проверено
- errors: количество найденных битых ссылок
- last_pages: последние 4 проверенные страницы, для каждой отображается:
- id: уникальный в рамках проверки идентификатор
- scheme: протокол сайта, HTTP или HTTPS
- host: сайт, к которому относится ссылка
- url: относительный путь к странице
- linktext: текст ссылки, приведшей на данную страницу
- title: заголовок страницы
- referer: с какой страницы вела ссылка на данную страницу
- badlinks: найденные битые ссылки:
- id: идентификатор страницы, на которой обнаружена битая ссылка
- referer: адрес страницы, на которой обнаружена битая ссылка
- errors: список битых сслок для данной страницы:
- id: уникальный в рамках проверки идентификатор
- host: сайт, к которому относится ссылка
- url: относительный адрес битой ссылки
- linktext: текст битой ссылки
- host: адрес проверяемого сайта
- hash: уникальный код проверки, который будет необходим для дальнейших запросов
Заключение
В случае возникновения каких-либо сложностей или предложений, будем рады ответить на все Ваши вопросы по электронной почте support@badlinks.ru.
