URL запроса

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

apikey *

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

lang

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

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

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

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

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

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

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

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

id

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

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

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

• цифры;

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

only_errors

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

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

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

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

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

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

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

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

Тело запроса содержит HTML-код проверяемого документа.

Пример

Запрос для проверки корректности документа по его HTML-коду.

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

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

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

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

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

URL запроса:

https://validator-api.semweb.yandex.ru/v1.1/document_parser?apikey=12345a12-3b4c-5123-d4ef-g51h23ij451&pretty=true&id=1&lang=ru

Тело запроса:

<div vocab="http://schema.org/" typeof="Movie">
<h1 property="name">Pirates of the Carribean: On Stranger Tides (2011)</h1>
<span property="description">Jack Sparrow and Barbossa embark on a quest to
 find the elusive fountain of youth, only to discover that Blackbeard and
 his daughter are after it too.</span>
Director:
 <div property="director"  typeof="Person">
<span property="name">Rob Marshall</span>
</div>
Writers:
 <div property="author"  typeof="Person">
<span property="name">Ted Elliott</span>
</div>
<div property="author"  typeof="Person">
<span property="name">Terry Rossio</span>
</div>
, and 7 more credits
Stars:
 <div property="actor"  typeof="Person">
<span property="name">Johnny Depp</span>,
 </div>
<div property="actor"  typeof="Person">
<span property="name">Penelope Cruz</span>,
</div>
<div property="actor"  typeof="Person">
<span property="name">Ian McShane</span>
</div>
<div property="aggregateRating"  typeof="AggregateRating">
  <span property="ratingValue">8</span>/<span property="bestRating">10</span> stars from
  <span property="ratingCount">200</span> users.
  Reviews: <span property="reviewCount">50</span>.
</div>
</div>

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