API Массовой проверки

Инструмент "Массовая проверка доменов" позволяет проверять параметры нескольких доменов одновременно посредством API, работающего по спецификации JSON API.

Получение API-ключа

API-ключ можно получить или сбросить на странице настроек вашего аккаунта здесь.

Создание задачи

Для создания задачи по получению параметров доменов необходимо отправить POST-запрос следующего вида:

Пример запроса

curl --location 'https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/' \
--header 'Content-Type: application/vnd.apijson' \
--header 'Api-Key: ***' \
--data '{
 "data": {
  "type" : "toolTasks", "attributes" : {
    "toolName" : "checkDomains", "params" : {
      "domains" : [ "reg.ru", "nix.ru", "www.abbyy.com" ],
                  "checkedDomains" : [],
									"testsNames" : {
										"ip.ip" : true,
										"semRush.semRushCosts" : true,
										"vkontakteSocial.groupName": true,
										"vkontakteSocial.groupMembersCount" : true
									}
							}
					}
			}
	}
'

Пример успешного ответа

{
  "data" : {
    "type" : "toolTasks",
             "id" : "5a124a6891616b0ae13db4bd48fef375",
						 "meta": {"wsChannelName" : "analysis:tools.ff0ef6bac9b936bbd3ca5e325095f505"},
						 "attributes" : {
						 "params" : {
						   "domains" : [ "reg.ru", "nix.ru", "www.abbyy.com" ],
						   "checkedDomains" : [],
						   "testsNames" : {
						     "ip" : ["ip"],
						     "semRush" : ["semRushCosts"],
						     "vkontakteSocial" : [ "groupName", "groupMembersCount" ]
						   }
						 },
             "isExpired" : false,
						 "isUpdating" : true,
             "updated": "2024-08-14T10:03:1303:00",
            "until" : 0
    }
  }
}

Получение результатов задачи

Используя id задачи, можно запросить её результаты:

Пример запроса

curl --location --globoff 'https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/5a124a6891616b0ae13db4bd48fef375?filter[since]=0&include=tests' \
--header 'Content-Type: application/vnd.apijson' \
--header 'Api-Key: ***' \
--data ''

Пример ответа

{
  "data": {
    "type": "toolTasks",
    "id": "5a124a6891616b0ae13db4bd48fef375",
    "meta": {
      "wsChannelName": "analysis:tools.ff0ef6bac9b936bbd3ca5e325095f505"
    },
    "attributes": {
      "params": {
        "domains": [
          "reg.ru",
          "nix.ru",
          "www.abbyy.com"
        ],
        "checkedDomains": [],
        "testsNames": {
          "ip": [
            "ip"
          ],
          "semRush": [
            "semRushCosts"
          ],
          "vkontakteSocial": [
            "groupName",
            "groupMembersCount"
          ]
        }
      },
      "isExpired": false,
      "isUpdating": false,
      "updated": "2024-08-14T10:44:30+03:00",
      "until": 1723621521247
    },
    "relationships": {
      "tests": {
        "data": [
          {
            "type": "tests",
            "id": "5a124a6891616b0ae13db4bd48fef375-checkDomainsTool"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "tests",
      "id": "5a124a6891616b0ae13db4bd48fef375-checkDomainsTool",
      "attributes": {
        "name": "checkDomainsTool",
        "updated": "2024-08-14T10:44:30+03:00",
        "isExpired": false,
        "status": "info",
        "results": {
          "progress": 1,
          "checkDomainsDomainsTests": [
            {
              "domain": "reg.ru",
              "isActual": true,
              "updated": "2024-08-13T16:41:29+03:00",
              "tests": {
                "ip": {
                  "ip": "194.67.72.31",
                  "updated": "2024-08-13T16:41:29+03:00"
                },
                "semRush": {
                  "semRushCosts": null,
                  "updated": null
                },
                "vkontakteSocial": {
                  "groupName": "REG.RU",
                  "groupMembersCount": 52381,
                  "updated": "2022-03-11T11:42:14+03:00"
                }
              },
              "isUpdating": false
            },
            {
              "domain": "nix.ru",
              "isActual": true,
              "updated": "2024-08-13T18:10:21+03:00",
              "tests": {
                "ip": {
                  "ip": "91.233.230.52",
                  "updated": "2024-08-13T18:10:19+03:00"
                },
                "semRush": {
                  "semRushCosts": null,
                  "updated": null
                },
                "vkontakteSocial": {
                  "groupName": "НИКС - Компьютерный Супермаркет",
                  "groupMembersCount": 66155,
                  "updated": "2024-08-13T18:10:21+03:00"
                }
              },
              "isUpdating": false
            },
            {
              "domain": "www.abbyy.com",
              "isActual": false,
              "isUpdating": false,
              "tests": [],
              "updated": null
            }
          ]
        }
      }
    }
  ]
}

В данном случае в базе данных были найдены параметры только для двух доменов: reg.ru и nix.ru. Пустые поля tests и updated у домена www.abbyy.com указывают на то, что этот домен еще не был проанализирован и данные по нему отсутствуют.

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

Если необходимо получить актуальные параметры по каким-то из доменов (указанных в поле domains), то в поле checkedDomains указывается соответствующий массив.

Расчет стоимости задачи

При использовании инструмента происходит снятие пользовательских лимитов. Стоимость каждой задачи определяется набором необходимых параметров, а также списком доменов для обновления (checkedDomains). В таблице ниже представлен список всех доступных параметров.

Пример расчета стоимости задачи

Пример задачи:

{
    "domains": ["reg.ru", "nix.ru", "www.abbyy.com"],
    "checkedDomains": [],
    "testsNames": {
        "ip.ip": true,
        "semRush.semRushCosts": true,
        "vkontakteSocial.groupName": true,
        "vkontakteSocial.groupMembersCount": true
    }
}

Эта задача оценивается в 3 лимита, так как не указаны checkedDomains и присутствуют параметры из 3-х групп.

Если необходимо обновление всех указанных доменов:

{
  "domains": ["reg.ru", "nix.ru", "www.abbyy.com"],
  "checkedDomains": ["reg.ru", "nix.ru", "www.abbyy.com"]
}

То стоимость составит уже 9 лимитов (по 3 за каждый домен в checkedDomains).

Запрос на получение стоимости задачи

Для получения стоимости задачи необходимо отправить запрос, аналогичный созданию задачи, заменив URL на https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/cost.

Пример запроса

curl --location 'https://apis.pr-cy.ru/api/v2.1.0/tool-tasks/cost' \
--header 'Content-Type: application/vnd.apijson' \
--header 'Api-Key: ***' \
--data '{
 "data": {
 "type": "toolTasks",
 "attributes": {
 "toolName": "checkDomains",
 "params": {
 "domains": ["reg.ru", "nix.ru", "www.abbyy.com"],
 "checkedDomains": [],
 "testsNames": {
 "ip.ip": true,
 "semRush.semRushCosts": true,
 "vkontakteSocial.groupName": true,
 "vkontakteSocial.groupMembersCount": true
 }
 }
 }
 }
}'

Пример ответа

{
    "data": {
        "type": "taskCosts",
        "id": "5a124a6891616b0ae13db4bd48fef375-cost",
        "attributes": {
            "cost": 3
        }
    }
}

Заключение

Инструмент "Массовая проверка доменов" предоставляет мощные возможности для анализа множества доменов одновременно. Используя API, вы можете автоматизировать процесс проверки и получения данных, что значительно упрощает управление доменами и их аналитикой.