API доступности веб-сайтов

API доступности веб-сайтов, оптимизированное для масштабируемости.

Для использования API A11yWatch добавьте в заголовок авторизации формат JWT в форматеBearer TOKEN. Дополнительную информацию можно найти в документах OpenAPI, GraphQL или gRPC. Использование API представляет собой платную подписку.

Аутентификация и пользователи
- https://api.a11ywatch.com/api/user
  GET
  curl --location --request GET 'https://api.a11ywatch.com/api/user' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/login
  POST
  email stringАдрес электронной почты учетной записи для входа.Обязательное полеpassword stringПароль учетной записи для входа.Обязательное поле
  curl --location --request POST 'https://api.a11ywatch.com/api/login' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "email": "example@email.com", "password": "somethingsafe" }'
Операции с отчетами
- https://api.a11ywatch.com/api/scan
  POST
  url stringURL для анализа и исследования.Обязательное поле
  curl --location --request POST 'https://api.a11ywatch.com/api/scan' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/crawl
  POST
  url stringURL для анализа и исследования.Обязательное полеsubdomains booleanВключать поддомены, соответствующие домену.sitemap numberВключать ссылки на карту сайта - 0 для отключения, 1 для анализа только карты сайта, 2 для расширенного исследования через карту сайта.tld booleanВключать все допустимые TLD-расширения, соответствующие домену.csv Header [Accept: text/csv]Обработать данные как CSV, а не как JSON.standard stringСтандарт доступности веб-сайта. Один из WCAGA, WCAGAA, или WCAGAAA.
  curl --location --request POST 'https://api.a11ywatch.com/api/crawl' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/websites-sync
  POST
  curl --location --request POST 'https://api.a11ywatch.com/api/websites-sync' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json'
Управление веб-сайтами
- https://api.a11ywatch.com/api/website
  POST
  url stringURL веб-сайта.Обязательное полеcustomHeaders string[{key: string, value: string}]Массив объектов, содержащий настройки заголовков (ключ-значение).mobile booleanВыполнять проверку в мобильном виде?standard stringСпецификация WCAG2.1, которую нужно использовать, например WCAG2A, WCAG2AA или WCAG2AAA.
  curl --location --request POST 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' --header 'Content-Type: application/json' -d '{ "websiteUrl": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website?domain=https://mywebsite.com
  GET
  url stringURL веб-сайта.Обязательное поле
  curl --location --request GET 'https://api.a11ywatch.com/api/website?domain=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website
  PUT
  url stringURL веб-сайта.Обязательное полеcustomHeaders string[{key: string, value: string}]Массив объектов, содержащий настройки заголовков (ключ-значение).mobile booleanВыполнять проверку в мобильном виде?standard stringСпецификация WCAG2.1, которую нужно использовать, например WCAG2A, WCAG2AA или WCAG2AAA.
  curl --location --request PUT 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "url": "https://mywebsite.com" }'
- https://api.a11ywatch.com/api/website
  DELETE
  url URL веб-сайта.domain stringИмя веб-сайта.deleteMany booleanУдалить все веб-сайты и связанные данные.
  curl --location --request DELETE 'https://api.a11ywatch.com/api/website' --header 'Authorization: $A11YWATCH_TOKEN' -d '{ "domain": "a11ywatch.com" }'
- https://api.a11ywatch.com/api/report?url=https://mywebsite.com
  GET
  url URL для анализа и исследования.Обязательное полеdownload booleanСкачать отчет в формате Excel.csv booleanОбработать данные как CSV, а не как JSON.
  curl --location --request GET 'https://api.a11ywatch.com/api/report?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com
  GET
  url URL веб-сайта.Обязательное поле
  curl --location --request GET 'https://api.a11ywatch.com/api/analytics?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com
  GET
  url URL для анализа и исследования.Обязательное поле
  curl --location --request GET 'https://api.a11ywatch.com/api/website/export-pdf?url=https://mywebsite.com' --header 'Authorization: $A11YWATCH_TOKEN'
Списки результатов
- https://api.a11ywatch.com/api/list/website?offset=0
  GET
  offset numberПозиция страницы для получения следующего пагинированного набора.search stringПоиск проблем на странице.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/website?offset=0' --header 'Authorization: $A11YWATCH_TOKEN' undefined
- https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com
  GET
  offset numberПозиция страницы для получения следующего пагинированного набора.domain stringИмя веб-сайта.search stringПоиск проблем на странице.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/issue?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/pages?offset=0
  GET
  offset numberПозиция страницы для получения следующего пагинированного набора.domain stringИмя веб-сайта.search stringПоиск проблем на странице.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/pages?offset=0' --header 'Authorization: $A11YWATCH_TOKEN'
- https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com
  GET
  offset numberПозиция страницы для получения следующего пагинированного набора.domain stringИмя веб-сайта.pageUrl stringURL веб-сайта.
  curl --location --request GET 'https://api.a11ywatch.com/api/list/analytics?offset=0&domain=a11ywatch.com' --header 'Authorization: $A11YWATCH_TOKEN'

По умолчанию документация API A11yWatch объясняет, как взаимодействовать с API через HTTP при помощи cURL. Для большинства путей можно отправлять параметры из URL или тела запроса. Лучше всего использовать HTTP PUT и POST запросы с телом запроса, так как для некоторых параметров требуется установить массив в виде таблицы и другие формы, а для других может использоваться другой формат. В этом примере заменитеa11ywatch.com на веб-сайт, который вы хотите проверить. Использование A11yWatch в CI добавляет осведомлённость и существенно снижает затраты на разработку, позволяя обнаруживать проблемы перед финальным релизом.

Оставайтесь включительными с уверенностью

Начните сейчас с A11yWatch для автоматизированных, эффективных и доступных инструментов для веб-доступности.

Начать

API доступности веб-сайтов

API доступности веб-сайтов, оптимизированное для масштабируемости.

Аутентификация и пользователи

Операции с отчетами

Управление веб-сайтами

Списки результатов

Оставайтесь включительными с уверенностью