Zidium

Взаимодействие с системой мониторинга Zidium выполняется через веб-сервис Api.

Для работы через Api вам нужно знать имя аккаунта и секретный ключ. Их можно посмотреть на странице аккаунта: Управление — Аккаунт.

Чтобы проверить соединение, выполните команду "эхо". Данная команда получает на вход любую строку, и возвращает ее в ответе, если имя аккаунта и секретный ключ указаны верно.

Для выполнения команды "эхо" используйте код:

/// <summary>
/// Статический хэлпер для доступа к функциям Zidium из любого кода
/// </summary>
public static class ZidiumHelper
{
    private static IClient _client;
/// <summary> /// Возвращает клиента Zidium (обертка над веб-сервисом). /// </summary> public static IClient GetClient() { if (_client == null) { lock (typeof(ZidiumHelper)) { if (_client == null) { // Получим конфиг и укажем данные аккаунта var zidiumConfig = ConfigHelper.LoadFromXmlOrGetDefault(); zidiumConfig.Access.AccountName = "ИмяВашегоАккаунта"; // Посмотрите в личном кабинете zidiumConfig.Access.SecretKey = "caf508d2-XXXX-XXXX-XXXX-6a2ef73a2b49"; // Посмотрите в личном кабинете
// Получим клиент Zidium var _client = new Client(zidiumConfig); } } } return _client; } }
private static void TestConnection() { // Получим клиент Zidium var zidiumClient = ZidiumHelper.GetClient();
// Проверим соединение командой "Эхо" var echoResponse = zidiumClient.ApiService.GetEcho("Test message");
if (echoResponse.Success) { Console.WriteLine("Соединение успешно установлено"); Console.WriteLine("Echo: " + echoResponse.Data); } else { Console.WriteLine("Не удалось установить соединение"); Console.WriteLine("Код ошибки: " + echoResponse.Code); Console.WriteLine("Текст ошибки: " + echoResponse.ErrorMessage); } }

Каждый ответ веб-сервиса содержит код и сообщение об ошибке. Код ошибки 10 - означает, что запрос выполнен успешно, иначе - ошибка.

Для отправки команды "эхо" выполните POST-запрос:

Url запроса

http://ИмяВашегоАккаунта.api.zidium.net/1.0/GetEcho

Тело запроса
{
    "Token": {
        "SecretKey": "caf508d2-XXXX-XXXX-XXXX-6a2ef73a2b49"
    },
    "Data": {
        "Message": "Test message"
    }
}

Здесь:

  • Token — раздел с токеном авторизации. В нём:
    • SecretKey — секретный ключ аккаунта, посмотрите в личном кабинете;
  • Data — раздел с данными. В нём:
    • Message — любое текстовое сообщение.

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

{
    "Data": "Test message",
    "Code": 10
}

Нужно убедиться, что Code равно 10, что означает успешное выполнение.