Update. Проверка по хэшу

Запрос позволяет узнать, содержатся ли проверяемые URL в списках Safe Browsing. Вычислите префикс хэша для URL и выполните поиск по локальной базе. Если префикс хэша найден хотя бы в одном из списков, запрос возвращает информацию об угрозе, которую URL представляет для пользователя.

Примечание. Перед поиском убедитесь, необходимые вам списки Safe Browsing полностью скачаны и локальная база находится в актуальном состоянии. В противном случае используйте запрос Lookup. Проверка по URL.

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

POST https://sba.yandex.net/v4/fullHashes:find
 ? key=<API-ключ>

key *

Значение API-ключа.

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

Тело запроса

{
  "client": {
    "clientId": "{string}",
    "clientVersion": "{string}"
  },
  "clientStates": ["{string}"],
  "threatInfo": {
    "threatTypes": ["{enum}"],
    "platformTypes": ["{enum}"],
    "threatEntryTypes": ["{enum}"],
    "threatEntries": [
      {"hash": "string"}
    ]
  }
}

client

Данные пользователя API Safe Browsing. Используются для идентификации запросов, сделанных от его имени.

clientId

Имя пользователя.

clientVersion

Версия реализации.

clientStates

Статусы списков Safe Browsing на момент последнего обновления. Массив объектов.

Актуальное значение для каждого списка возвращается в параметре newClientState запроса Update. Обновление локальной базы списков SB.

threatInfo

Параметры списков Safe Browsing и проверяемые ресурсы.

threatTypes

Вид угрозы. Массив объектов.

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

THREAT_TYPE_UNSPECIFIED — неизвестная угроза.
MALWARE — вредоносное программное обеспечение.
SOCIAL_ENGINEERING — угрозы социальной инженерии.
UNWANTED_SOFTWARE — нежелательное программное обеспечение.
POTENTIALLY_HARMFUL_APPLICATION — потенциально опасное приложение.

platformTypes

Платформа. Массив объектов.

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

PLATFORM_TYPE_UNSPECIFIED — платформа неизвестна.
WINDOWS — Windows.
LINUX — Linux.
ANDROID — Android.
OSX — OS X.
IOS — iOS.
ANY_PLATFORM — минимум одна платформа из списка.
ALL_PLATFORMS — все платформы.
CHROME — Chrome.

threatEntryTypes

Тип объекта, который представляет угрозу. Массив объектов.

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

THREAT_ENTRY_TYPE_UNSPECIFIED — тип неизвестен.
URL — URL.
EXECUTABLE — исполняемая программа.

threatEntries

Проверяемые ресурсы. Массив объектов.

hash

Префикс хэша.

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

Формат ответа приведен ниже. Порядок следования и наличие элементов не гарантируется. В ответе могут присутствовать служебные параметры, которые не описаны в документе.

Формат ответа

Ответ содержит подробную информацию об опасности, представляемой каждым из найденных ресурсов.

Если ни один из проверяемых префиксов хэшей не обнаружен в списках Safe Browsing на сервере, тело ответа содержит только параметр negativeCacheDuration. Если совпадения есть, ответ содержит подробную информацию об опасности, представляемой каждым из найденных ресурсов.

{
  "matches": [
    {
      "threatType": "{еnum}",
      "platformType": "{еnum}",
      "threatEntryType": "{еnum}",
      "threat": {"hash": "{string}"},
      "cacheDuration": "{string}"
    }
  ],
  "minimumWaitDuration": "{string}",
  "negativeCacheDuration": "{string}"
}

matches

Информация о ресурсах, найденных в списках Safe Browsing. Массив объектов.

threatType

Вид угрозы.

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

THREAT_TYPE_UNSPECIFIED — неизвестная угроза.
MALWARE — вредоносное программное обеспечение.
SOCIAL_ENGINEERING — угрозы социальной инженерии.
UNWANTED_SOFTWARE — нежелательное программное обеспечение.
POTENTIALLY_HARMFUL_APPLICATION — потенциально опасное приложение.

platformType

Платформа, которая подвергается угрозе.

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

PLATFORM_TYPE_UNSPECIFIED — платформа неизвестна.
WINDOWS — Windows.
LINUX — Linux.
ANDROID — Android.
OSX — OS X.
IOS — iOS.
ANY_PLATFORM — минимум одна платформа из списка.
ALL_PLATFORMS — все платформы.
CHROME — Chrome.

threatEntryType

Тип объекта, который представляет угрозу.

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

THREAT_ENTRY_TYPE_UNSPECIFIED — тип неизвестен.
URL — URL.
EXECUTABLE — исполняемая программа.

threat

Ресурс, представляющий угрозу.

hash

Хэш полной длины для URL.

cacheDuration

Время хранения в кэше информации об угрозе, которую ресурс представляет для пользователя. Задается в секундах в формате "<время>s".

minimumWaitDuration

Минимальное время в секундах до повторной отправки запроса. Задается в формате "minimumWaitDuration": "<время>s". Допускается до девяти знаков после запятой.

negativeCacheDuration

Время хранения в кэше информации для ресурсов, не обнаруженных в локальных списках Safe Browsing. Задается в секундах в формате "<время>s". В течение указанного времени документы считаются безопасными для пользователя.

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

Пример

Адрес запроса:

https://sba.yandex.net/v4/fullHashes:find?key=2f8...8ea

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

{
  "client": {
    "clientId": "client_name",
    "clientVersion": "1.1.1"
  },
  "threatInfo": {
    "threatTypes": ["MALWARE", "SOCIAL_ENGINEERING"],
    "platformTypes": ["WINDOWS", "ALL_PLATFORMS"],
    "threatEntryTypes": ["URL"],
    "threatEntries": [
      {"hash": "N2JjODJjN2U="}
    ]
  }
}

Ответ:

{
  "negativeCacheDuration": "1200.00s"
}