API (Russian)

From WOT Wiki
Revision as of 05:19, 29 October 2016 by ScamKiller73 (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Данная страница описывает технические возможности WOT API v0.4 и создана для разработчиков программ, использующих WOT.

Условия и положения

Перед тем, как продолжить, обратите внимание, что, помимо Условий использования, которые применимы ко всем сервисам WOT, существуют и Условия использования API.

Регистрация

Для использования API вам необходимо получить персональный API ключ. Для получения персонального ключа вам необходимо иметь учетную запись WOT. Если вы еще не регистрировались - пройдите процедуру регистрации, если у вас уже есть учетная запись WOT - вы можете запросить персональный API ключ перейдя по следующей ссылке.

После того, как вы запросили персональный API ключ, в вашем профиле появится новая вкладка, на которой вы можете посмотреть ваш API ключ и предоставить в WOT информацию об его использовании.

Введение

Система WOT вычисляет репутацию сайтов, используя рейтинги, полученные от пользователей, и информацию из сторонних источников. Этот раздел содержит краткое введение в некоторые понятия, которые необходимо знать для разработки приложений, использующих данные репутаций.

Хосты (targets)

Репутация вычисляется для сайтов, которые идентифицируются по их DNS имени. IPv4 или IPv6 адреса также могут быть использованы вместо имени. WOT так же поддерживает Internationalized Domain Names (IDN), которые должны быть закодированы в ASCII в соответствии с RFC 3490.

Например: 

 ääkkönen.fi = xn--kknen-fraa0m.fi

Репутация

Репутация задается для хостов по двум компонентам. Для каждой пары {хост, компонент} система вычисляет два значения: Репутация и Уверенность в репутации. Вместе эти значения показывают степень доверия к хосту по соответствующему компоненту.

Компоненты

Компоненты репутации идентифицируются по номерам:

Идентификатор компонента Описание Вопрос, на который отвечают пользователи, давая оценку:
0 Заслуживает доверия “Насколько я доверяю этому сайту?”
4 Безопасность для детей “Насколько этот сайт подходит для детей?”

Примечание: Компоненты 1 и 2 являются устаревшими. API будет продолжать возвращать данные для этих компонентов для обеспечения совместимости, но эти компоненты не должны использоваться в новых приложениях. Тем, кто заинтересован в типе информации, которая включалась в устаревшие компоненты, рекомендуется изучить раздел категорий ниже.

Репутация и Уверенность

Репутация r ∊ {0, ..., 100} является оценкой коллективного доверия к цели по конкретному компоненту. Чем выше значение, тем больше сообщество доверяет сайту. Описания для различных значений репутации приведены в таблице:

Значение репутации Описание Символ
≥ 80 Превосходно 16 excellent.png
≥ 60 Хорошо 16 good.png
≥ 40 Неудовлетворительно 16 unsatisfactory.png
≥ 20 Плохо 16 poor.png
≥ 0 Очень плохо 16 verypoor.png

WOT использует визуальное представление для индикации репутации (эта картинка поясняет структуру): ReputationHelp RU.png

ConfidenceSample.png

Уверенность "c" ∊ {0, ..., 100} показывает оценку надежности репутации для пары {цель, компонент}. Чем выше значение, тем выше уверенность в оценке репутации.

Вы должны использовать показатель уверенности для исключения ложных срабатываний (репутацию при "c" < 6 нельзя считать сколь-нибудь надежной). Например, для расширения WOT требуется значение уверенности ≥ 10 для того, чтобы показать окно предупреждения о отрываемом сайте. Использование высокого порога уверенности приведет к уменьшению ложных срабатываний, но также приведет к тому, что приложение будет меньше реагировать на сайты с плохой репутацией. Вы можете экспериментировать с разными порогами уверенности, чтобы увидеть, который наилучшим образом соответствует вашему приложению. Мы рекомендуем порог от 12 до 20 для отображения предупреждения.

Категории

В дополнение к репутации, система также вычисляет категорий для сайтов на основе голосов от пользователей и доверенных источников данных. Категории призваны объяснить причину плохой репутации. Текущие категории:

Группа категории Идентификатор категории Описание
Негативные 101 Вредоносное содержимое
102 Отрицательный опыт сотрудничества
103 Фишинг
104 Мошенничество
105 Потенциально незаконное
Сомнительные 201 Неэтичный или вводящий в заблуждение
202 Риски конфиденциальности
203 Подозрительный сайт
204 Разжигание ненависти, дискриминация
205 Спам
206 Потенциально нежелательное ПО
207 Реклама или всплывающие окна
Нейтральные 301 Онлайн слежение
302 Альтернативная или спорная медицина
303 Мнения, религия, политика
304 Прочее
Позитивные 501 Хороший сайт

Следующие категории предоставляют информацию о безопасности для детей:

Группа категории Идентификатор категории Описание
Негативные 401 Материал только для взрослых
403 Отвратительный или шокирующий материал
Сомнительные 402 Случайное обнажение (откровенная одежда)
Позитивные 404 Сайт, созданный специально для детей

Для каждой категории Система репутаций также вычисляет значение уверенности "ε" {0, ..., 100}, как и для репутации. Чем выше значение, тем выше надежность присвоенной категории. Если вы используете категории для определения категории тяжести плохой репутации, вы можете использовать более низкий порог уверенность для категоризации данных. Система выдает категорию при "c" > 3. Для принятия решения в вашем продукте мы рекомендуем опираться на категории с "c" > 6.

WOT использует визуальное представление для категории групп и их уверенности: CategoryHelp RU.png

Сторонние источники данных

Если веб-сайт находится в стороннем черном списке и это влияет на репутацию сайта, то API возвращает информацию о типе черного списка, в котором сайт был найден. Ниже приведен список типов черных списков:

Тип чёрного списка Описание
malware Сайт попал в чёрный список за распространение вредоносного содержимого.
phishing На сайте была размещена фишинговая страница.
scam Сайт попал в чёрный список из-за мошенничества (например, фальшивая онлайн-аптека).
spam Сайт попал в чёрный список из-за рассылки спама или рекламы с помощью спама.

Примечание. Если сайт находится сразу в нескольких сторонних черных списках одного типа, то будет возвращена дата последнего занесения в список.

Запросы

API состоит из нескольких интерфейсов, каждый из которых вызывается использованием обычных HTTP GET запросов к api.mywot.com и возвращающих ответ в формате JSON в случае успешного выполнения. Коды статуса HTTP используются для возвращения информации об ошибках, параметры передаются с использованием стандартных конвенций URL. Формат запроса выглядит следующим образом: 

 http://api.mywot.com/version/interface?param1=value1&param2=value2

TLS шифрование может быть использовано со всеми интерфейсами.

Техническая документация: Reputation API

public_link_json2

Public_link_json2 API используется для запроса репутации для нескольких хостов.

Параметры

hosts
Список доменов, разделенных косой чертой ("/"). Например, www.example.com/another.example.net/onemore.example.org/. Значение должно заканчиваться косой чертой и должны включать не более 100 имен. Примечание: полный путь запроса также должен быть менее 8 КБ, иначе он будет отклонен.
callback (опционально)
Название функции обратного вызова для ответа в JSONP (JSON with Padding) формате.
key
Ваш Ключ API.

Коды возврата

Если запрос был успешным, то возвращается HTTP код 200. Если произошла ошибка на стороне сервера - код 500. Если запрос содержал некорректный ключ API или некорректный параметр, код статуса будет 403. Если вы превысили дневной лимит, вернётся код 429.

Возвращаемые данные

API возвращает репутацию, категории и информацию о сторонних источниках данных в формате JSON или JSONP в зависимости от параметра обратного вызова, указанного в запросе. Формат выглядит следующим образом:

  1. Объект ответа имеет один атрибут для каждого домена, названный неизмененным именем заданного параметром хоста.
  2. Каждый целевой объект имеет целевой атрибут, который содержит нормализованное название цели.
  3. Каждый целевой объект также имеет атрибуты компонентов, ∊ {“0”, ...}.
    1. Каждый атрибут компонента содержит массив с значениями {r, c} для репутации компонента. Если репутация для компонента неизвестна, соответствующего атрибута в ответе не будет.
  4. Каждый целевой объект также может иметь атрибут категории, который содержит один или более идентификатор атрибутов категории и их значения уверенности.
  5. Каждый целевой объект также может иметь атрибут черного списка, который содержит один или более типов черного списка и Unix-метку времени, когда сайт был последний раз добавлен в список сторонних источников данного типа.

Пример

Запрос: 

 http://api.mywot.com/0.4/public_link_json2?hosts=example.COM/www.EXAMPLE.NET/&callback=process&key=<your API key>

Ответ: 

 process({
   "example.COM": {
     "target": "example.com",
     "0": [ 91, 53 ],
     "4": [ 93, 53 ],
     "categories": {
       "501": 71,
       "304": 37
     }
   },
   "www.EXAMPLE.NET": {
     "target": "example.net",
     "0": [ 9, 43 ],
     "categories": {
       "101": 54
     },
     "blacklists": {
       "malware": 1362123608
     }
   }
 })
Retrieved from "https://www.mywot.com/wiki/index.php?title=API_(Russian)&oldid=20003"