Валидация по URL

Формат запроса

Внимание

URL запроса содержит номер версии API Валидатора микроразметки. Узнать актуальное значение можно в разделе Версии API.

https://validator-api.semweb.yandex.ru/v1.1/url_parser
  ? apikey=<API-ключ>
  & [url=<адрес документа>]
  & [lang=<язык сообщений об ошибках>]
  & [pretty=<формат вывода ответа>]
  & [id=<идентификатор запроса>]
  & [only_errors=<вид ответа>]

Значение API-ключа. Получить бесплатный API-ключ можно в Кабинете разработчика.

Адрес проверяемого документа.   Специальные символы в URL проверяемого документа необходимо заменять на экранированные последовательности в соответствии с percent-encoding. Например, вместо знака амперсанд (&) необходимо использовать последовательность «%26».

Язык сообщений об ошибках в микроразметке.   Возможные значения:

  • «ru» — русский;
  • «en» — английский;
  • «uk» — украинский;
  • «tr» — турецкий.   Если параметр lang не задан, сообщения об ошибке формируются на английском языке (значение по умолчанию — «en»).

Вариант представления ответа на запрос.   Возможные значения:

  • «false» — результат запроса выводится сплошным текстом;
  • «true» — результат запроса выводится в виде, адаптированном для чтения человеком.   Если параметр pretty не задан, результат запроса выводится без переноса строк (значение по умолчанию — «false»).

Идентификатор запроса. Применяется при выполнении асинхронных запросов.   Может содержать:

  • латинские прописные и строчные буквы;
  • цифры;
  • символы: - (дефис) и _ (подчеркивание).

Вид возвращаемого ответа: стандартный или только ошибки.   Возможные значения:

  • «false» — возвращается стандартный ответ (содержит все поля проверяемого документа и их значения);
  • «true» — в ответе возвращается только информация о полях, содержащих ошибки.   Если при проверке документа ошибки не найдены, сервер возвращает код «204 No Content».

Если параметр only_errors не задан, возвращается стандартный ответ (значение по умолчанию — «false»).

apikey *

Значение API-ключа. Получить бесплатный API-ключ можно в Кабинете разработчика.

url

Адрес проверяемого документа.

Примечание

Специальные символы в URL проверяемого документа необходимо заменять на экранированные последовательности в соответствии с percent-encoding. Например, вместо знака амперсанд (&) необходимо использовать последовательность «%26».

lang

Язык сообщений об ошибках в микроразметке.

Возможные значения:

  • «ru» — русский;
  • «en» — английский;
  • «uk» — украинский;
  • «tr» — турецкий.

Если параметр lang не задан, сообщения об ошибке формируются на английском языке (значение по умолчанию — «en»).

pretty

Вариант представления ответа на запрос.

Возможные значения:

  • «false» — результат запроса выводится сплошным текстом;
  • «true» — результат запроса выводится в виде, адаптированном для чтения человеком.

Если параметр pretty не задан, результат запроса выводится без переноса строк (значение по умолчанию — «false»).

id

Идентификатор запроса. Применяется при выполнении асинхронных запросов.

Может содержать:

  • латинские прописные и строчные буквы;

  • цифры;

  • символы: - (дефис) и _ (подчеркивание).

only_errors

Вид возвращаемого ответа: стандартный или только ошибки.

Возможные значения:

  • «false» — возвращается стандартный ответ (содержит все поля проверяемого документа и их значения);

  • «true» — в ответе возвращается только информация о полях, содержащих ошибки.

    Если при проверке документа ошибки не найдены, сервер возвращает код «204 No Content».

Если параметр only_errors не задан, возвращается стандартный ответ (значение по умолчанию — «false»).

Обязательный параметр.

* Обязательный параметр.

Пример

Запрос для проверки корректности документа, размещенного по адресу: http://www.kinopoisk.ru/film/696464/.

Метод HTTP-запроса — GET.

Формат вывода ответа — адаптированный для чтения человеком (pretty=true).

Идентификатор запроса — 1 (id=1).

Язык сообщений об ошибке — русский (lang=ru).

Язык сообщений об ошибке — английский (lang=en).

Вид ответа — только ошибки (only_errors=true).

https://validator-api.semweb.yandex.ru/v1.1/url_parser?apikey=12345a12-3b4c-5123-d4ef-g51h23ij451&pretty=true&id=1&lang=ru&only_errors=true&url=http%3A%2F%2Fkinopoisk.ru%2Ffilm%2F696464%2F

Пример ответа на запрос представлен в разделе Формат ответа.

Предыдущая
Формат запроса
Следующая
Валидация по HTML