API Host-Tracker можно осуществить с помощью простых Http-запросов (REST API) или же при помощи более сложных запросов, основанных на протоколе SOAP (SOAP API)

Доступность сайта в сети — важнейшее условие его посещения пользователем. Пользователь, заходя на страницы веб-сайта, выполняет некоторые действия, которые в конечном итоге превращаются в материальную выгоду для владельца сайта — делает покупки, пользуется платными сервисами и прочее. Если веб-ресурс не был доступен какой-то период времени, то это оборачивается потерей репутации, прибылей, посетителей. Поэтому стабильность работы сайта следует отслеживать, мониторить его доступность в сети. Компания Host-Tracker предложила для этого ряд удобных сервисов, которые можно настраивать также, используя API сервиса Host-Tracker.

Поддержка REST и SOAP API

Host-Tracker предлагает возможность использовать сервис мониторинга как веб-службу, что очень удобно при необходимости создания десктопных, мобильных приложений, при осуществлении мониторинга большого числа веб-сайтов. Например, управлять мониторингом сайтов, количество которых переваливает за 1000, весьма проблематично. API-сервис разработан для тех разработчиков, которые желают интегрировать в свои приложения функциональные возможности, предлагаемые в Host-Tracker. Это можно осуществить с помощью простых Http-запросов (REST API) или же при помощи более сложных запросов, основанных на протоколе SOAP (SOAP API).

Настройка заданий

Настройка заданий по REST API может производиться в разных форматах. Заголовок Http-запроса Content-Type может быть определен как: application/json, text/xml, application/x-www-form-urlencoded (данные в виде «имя-значение»). В случае с SOAP API используется вызов удаленных процедур, что определены в технической документации сервиса. Примером таких функций могут стать: CreateHttpGetTask, CreateHttpHeadTask и множество других.

В рамках REST API с помощью POST запросов можно создавать задания: http-проверки, ping-проверки, а также проверки портов. Запросы, использующие метод PUT, позволят редактировать ранее созданное задание. С помощью GET-метода можно получить данные, принятые для настройки заданий или о самих заданиях, а при помощи DELETE-запроса предоставляется возможность удаления ранее настроенного задания. Так, запрос с методом GET к ресурсу api/web/v1/tasks/intervals в качестве ответа вернет данные о доступных в сервисе интервалах, которые определены следующими числами: 1, 5, 15, 30, 60. Для того чтобы получить те же значения, но через SOAP API, разработчику достаточно воспользоваться вызовом удаленной функции GetTaskIntervals. Использование метода POST совместно с ресурсом api/web/v1/tasks/http позволит создать задание Http-проверки.

Пример авторизации по REST API

Приведем простой пример авторизации в сервисе Host-Tracker, использующий простой Http-запрос. Чтобы выполнить авторизацию, необходимо послать POST-запрос для ресурса api/web/v1/users/token. В зависимости от выбранного формата поле заголовка Content-Type должно содержать одно из трех выше указанных значений. Например, если формат запроса и ожидаемого ответа должен быть в xml виде, тогда в поле заголовка должно значиться text/xml. Значение логина записывается в элементе <login>, а значение пароля — в <password>. Оба эти элемента являются дочерними узлами корневого элемента <LoginData>.

Рис.1.(Изображение, представляющее POST запрос авторизации в формате XML)

Авторизация в формате json также очень проста. Для ее реализации нужно лишь изменить значение ключевого заголовка Content-Type, а в теле документа передавать данные в формате json.

Рис.2.(Изображение, демонстрирующее POST запрос в формате JSON)

Детальная настройка заданий по REST API и SOAP API.