Вебхуки

Вебхуки — это уведомления о событиях, которые происходят на стороне системы. Система отправляет вебхуки, чтобы сообщить о результате операции, запросить подтверждение или предупредить о действиях, которые вам нужно совершить. В рамках вебхуков вы также можете получать информацию о применяемой комиссии за операцию. Чтобы подключить данную функциональность, обратитесь к менеджеру Инцидент Центра.

Как получать вебхуки

1. Создайте адрес в вашей системе, на который хотите получать вебхуки.
2. Передайте его менеджеру Инцидент Центра.

IP адреса, с которых может отправляться вебхук

Для реальных операций

• 178.154.206.150
• 158.160.99.130
• 178.154.226.49

Для тестирования

• 178.154.231.226

Что отправлять в ответ

Запрос считается успешным только при получении ответа со статусом 200. Сервис будет ожидать успешного ответа на отправленный POST запрос в течение 30 секунд. В случае ответа любым другим статусом или по истечении указанного времени, отведённого на обработку запроса, сервис будет пытаться повторно доставить оповещения до получения успешного ответа, либо до истечения 5 повторных попыток.

Получение результатов сканирования (scan.finished)

Заголовки

Название	Тип	Описание
x-client-signature	string	Подпись запроса

Описание полей

Название	Описание
id	Идентификатор сканирования
started_at	Дата и время начала сканирования
finished_at	Дата и время завершения сканирования
merchant_id	Идентификатор мерчанта
marketplace_id	Идентификатор площадки
mode	Режим сканирования
results_url	Ссылка на результаты сканирования
details.assessment	Автоматическая оценка по резултатам сканирования
details.availability	Результат проверки на доступность
details.availability.status	Результат проверки на доступность корневой ссылки
details.availability.screenshots	Скриншот проверки на доступность корневой ссылки
details.availability.links	Результаты проверки на доступность дочерних ссылок
details.availability.links.items.url	Проверяемая ссылка
details.availability.links.items.is_available	Результат проверки на доступность
details.availability.links.items.type	Тип ссылки: внешняя или внутренняя
details.whois	Информация WHOIS по домену из запрошенной ссылки
details.whois.domain_owner	Владелец домена
details.whois.domain_registered_at	Дата регистрации домена
details.whois.domain_expired_at	Дата истечения регистрации домена
details.rkn	Результат проверки корневой ссылки в реестре РКН
details.rkn.screenshot	Скриншот проверки на сайте РКН
details.rkn.url	Проверяемая ссылка
details.rkn.results.number	Номер и дата основания для внесения в реестр РКН
details.rkn.results.authority	Орган, принявший решение о внесении в реестр РКН
details.rkn.results.type	Статус сайта
details.urls_by_lists	Найденные ссылки
details.urls_by_lists.illegal_sites	Найденные запрещенные ссылки
details.urls_by_lists.declined_marketplaces	Найденные отклоненные ссылки
details.urls_by_lists.rkn_sites	Найденные ссылки в реестре РКН
details.urls_by_lists.rkn_sites.items.screenshot	Скриншот проверки на сайте РКН
details.urls_by_lists.rkn_sites.items.url	Проверяемая ссылка
details.urls_by_lists.rkn_sites.items.results.number	Номер и дата основания для внесения в реестр РКН
details.urls_by_lists.rkn_sites.items.results.authority	Орган, принявший решение о внесении в реестр РКН
details.urls_by_lists.rkn_sites.items.results.type	Статус сайта
details.urls_by_classes	Результаты анализа найденных ссылок
details.urls_by_classes.internal	Найденные внутренние ссылки
details.urls_by_classes.external	Найденные внешние ссылки
details.urls_by_classes.privacy_policy	Найденные ссылки с правилами конфиденциальности
details.urls_by_classes.return_policy	Найденные ссылки с правилами возврата
details.urls_by_classes.delivery_policy	Найденные ссылки с правилами доставки
details.urls_by_classes.contacts	Найденные ссылки с контактами
details.words_by_lists	Сгруппированные найденные слова
details.words_by_lists.illegal_words	Найденные запрещенные слова
details.words_by_lists.illegal_words.items.word	Слово
details.words_by_lists.illegal_words.items.count	Количество слов
details.words_by_lists.illegal_words.items.urls	Страницы, на которых имеется данное слово
details.words_by_lists.mcc_code_words	Найденные слова по MCC коду
details.words_by_lists.mcc_code_words.items.word	Слово
details.words_by_lists.mcc_code_words.items.count	Количество слов
details.words_by_lists.mcc_code_words.items.urls	Страницы, на которых имеется данное слово
details.words_by_lists.brand_names	Найденные слова по брендовым наимнованиям
details.words_by_lists.brand_names.items.word	Слово
details.words_by_lists.brand_names.items.count	Количество слов
details.words_by_lists.brand_names.items.urls	Страницы, на которых имеется данное слово
details.redirect.is_redirected	Был ли редирект
details.redirect.redirected_url	URL, куда был редирект

Пример тела

{
  "event": "scan.finished",
  "result": {
    "id": "33f1a853-6c40-4887-ba81-3d50869e737d",
    "started_at": "2024-04-01T06:24:02.598Z",
    "finished_at": "2024-04-01T06:24:02.598Z",
    "merchant_id": "33f1a853-6c40-4887-ba81-3d50869e737d",
    "marketplace_id": "dd95883c-e2ed-492e-85b4-0c2d2e747ca5",
    "mode": "integration",
    "results_url": "https://datascope.pro/marketplace_collecting/00000000-0000-0000-0000-000000000000",
    "details": {
      "assessment": "compliant",
      "availability": {
        "status": "available",
        "screenshots": [
          "https://example.com/"
        ],
        "links": {
          "total": 1,
          "items": [
            {
              "url": "https://ya.ru/",
              "is_available": true,
              "type": "internal"
            }
          ]
        }
      },
      "whois": {
        "domain_owner": "YANDEX, LLC.",
        "domain_registered_at": "2024-04-01T06:24:02.598Z",
        "domain_expired_at": "2024-04-01T06:24:02.598Z"
      },
      "rkn": {
        "screenshot": "https://example.com/screenshot.jpg",
        "url": "https://example.com/",
        "results": [
          {
            "number": "string",
            "authority": "string",
            "type": "string"
          }
        ]
      },
      "urls_by_lists": {
        "illegal_sites": {
          "total": 1,
          "items": [
            "https://ya.ru/"
          ]
        },
        "declined_marketplaces": {
          "total": 1,
          "items": [
            "https://ya.ru/"
          ]
        },
        "rkn_sites": {
          "total": 1,
          "items": [
            {
              "screenshot": "https://example.com/screenshot.jpg",
              "url": "https://example.com/",
              "results": [
                {
                  "number": "string",
                  "authority": "string",
                  "type": "string"
                }
              ]
            }
          ]
        }
      },
      "urls_by_classes": {
        "internal": {
          "total": 1,
          "items": [
            "https://ya.ru/"
          ]
        },
        "external": {
          "total": 1,
          "items": [
            "https://ya.ru/"
          ]
        },
        "privacy_policy": {
          "total": 1,
          "items": [
            "https://ya.ru/"
          ]
        },
        "return_policy": {
          "total": 1,
          "items": [
            "https://ya.ru/"
          ]
        },
        "delivery_policy": {
          "total": 1,
          "items": [
            "https://ya.ru/"
          ]
        },
        "contacts": {
          "total": 1,
          "items": [
            "https://ya.ru/"
          ]
        }
      },
      "words_by_lists": {
        "illegal_words": {
          "total": 3,
          "items": [
            {
              "word": "проверка",
              "count": 3,
              "urls": [
                "https://ya.ru/"
              ]
            }
          ]
        },
        "mcc_code_words": {
          "total": 3,
          "items": [
            {
              "word": "проверка",
              "count": 3,
              "urls": [
                "https://ya.ru/"
              ]
            }
          ]
        },
        "brand_names": {
          "total": 3,
          "items": [
            {
              "word": "проверка",
              "count": 3,
              "urls": [
                "https://ya.ru/"
              ]
            }
          ]
        }
      },
      "redirect": {
        "is_redirected": true,
        "redirected_url": "https://redirected.com/test"
      }
    }
  }
}