// Получим проверку, если её ещё нет, то проверка будет создана автоматически
var unitTest = component.GetOrCreateUnitTestControl("CookieTransportService.DataCollectionTest");
// Отправим проверку, актуальную 10 минут
unitTest.SendResult(UnitTestResult.Success, TimeSpan.FromMinutes(10), "Приложение работает нормально");

Для создания или получения проверки выполните POST-запрос:

АдресВашегоСервисаApi/GetOrCreateUnitTest

{
    "Token": {
        "SecretKey": "caf508d2-XXXX-XXXX-XXXX-6a2ef73a2b49"
    },
    "Data": {
        "ComponentId": "11111111-2222-3333-4444-555555555555",
        "SystemName": "CookieTransportService.DataCollectionTest"}
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey — ключ доступа к Api, посмотрите в личном кабинете;
• Data — раздел с данными типа проверки. В нём:
  • ComponentId — Id компонента, для которого создаётся проверка. Его можно посмотреть в личном кабинете на странице компонента;
  • SystemName — системное имя проверки, должно быть уникальным.

В ответ возвратится сообщение следующего формата:

{
    "Data": {
        "Id": "c40b3723-7952-4592-a184-c62d890fa5aa",
        "TypeId": "464993cf-a11b-44d3-bc55-2dd0d7f76b24",
        "SystemName": "CookieTransportService.DataCollectionTest",
        "DisplayName": "CookieTransportService.DataCollectionTest"
    },
    "Code": 10
}

Нужно убедиться, что Code равно 10, что означает успешное выполнение. Из ответа нужно взять и сохранить Id, это Id проверки, который потребуется на следующем шаге для отправки результата. Однажды получив Id проверки, вы можете сохранить его где-то в своём приложении, чтобы не получать проверку каждый раз при отправке результата.

Для отправки результата пользовательской проверки выполните POST-запрос:

АдресВашегоСервисаApi/SendUnitTestResult

{
    "Token": {
        "SecretKey": "caf508d2-XXXX-XXXX-XXXX-6a2ef73a2b49"
    },
    "Data": {
        "UnitTestId": "c40b3723-7952-4592-a184-c62d890fa5aa",
        "Result": "Success",
        "Message": "Приложение работает нормально",
        "ActualIntervalSeconds": 600
    }
}

Здесь:

• Token — раздел с токеном авторизации. В нём:
  • SecretKey — ключ доступа к Api, посмотрите в личном кабинете;
• Data — раздел с данными проверки. В нём:
  • UnitTestId — Id проверки, для которой отправляется результат, из ответа на предыдущем шаге;
  • Result — результат проверки, может быть Success, Warning, Alarm;
  • Message — текст результата проверки;
  • ActualIntervalSeconds — интервал актуальности в секундах.