API

Действие list

Список всех проверок может быть получен следующим образом:

http://webopulsar.ru/api/wp.php?key=APIKEY&action=list

Возвращаемый формат данных (XML):

<item>
    <id></id>
    <url></url>
    <edges></edges>
    <status></status>
</item>

id - идентификатор проверки для дальнейших запросов.

url - URL проверки.

edges - узлы проверки.

status - статус проверки (OWN - собственная, SHARED - предоставлен только доступ для просмотра).

Действие get

Все данные проверок могут быть выгружены по обращениям вида

http://webopulsar.ru/api/wp.php?key=APIKEY&action=get&url=URLID&edge=0&start=STARTDATE&end=ENDDATE

Обязательных параметра три - key, action, url - если их не задать, то выведется ошибка.

APIKEY - ключ API, его можно посмотреть для каждого аккаунта на странице webopulsar.ru/account/ (внизу страницы).

URLID - ID проверки, его можно посмотреть на странице статистики проверок (выводится как параметр в экспортных данных (CSV, HTML, WIZ) - url_id - и как якорь блока проверки id="check-URLID").

edge - id узла, для которого будут выгружены данные, если узел не задать, то будут выгружены данные для всех узлов, с которых производится проверка, доступные узлы.

start - дата начала выгружаемых данных в формате YYYY-mm-dd, например, 2013-01-01

end - дата конца выгружаемых данных в формате YYYY-mm-dd, например, 2013-01-01

Возвращаемый формат данных (XML):

<item>
    <timestamp></timestamp>
    <response></response>
    <time></time>
    <details></details>
    <edge></edge>
</item>

timestamp - метка времени проверки.

response - код ответа, коды ошибок.

time - время ответа (если проверка прошла без ошибки), в соответствии с настройками проверки.

details - детали ошибки (если есть).

edge - номер узла, с которого пришли данные.

Действие add и alter

Создает проверку (add) или меняет ее (alter)

http://webopulsar.ru/api/wp.php?key=APIKEY&action=add&url=URL&type=1

Обязательных параметра четыре - key, action, url, type (или truetype) - если их не задать, то выведется ошибка.

APIKEY - ключ API, его можно посмотреть для каждого аккаунта на странице webopulsar.ru/account/ (внизу страницы).

URLID - URL проверяемого ресурса (для действия add) в формате urlencode или ID проверки, его можно посмотреть на странице статистики проверок (выводится как параметр в экспортных данных (CSV, HTML, WIZ) - url_id - и как якорь блока проверки id="check-URLID").

type (truetype для действия alter) - тип проверки, таблица типов приведена ниже.

Дополнительные параметры:

frequency, email, jabber, phone, callback, timeout, alert1, alert2, alert3, alert4, alert5, postdata, posttext, notext, username, password, email_recheck, phone_recheck, jabber_recheck, callback_recheck, traceroute, ping_type, cookie, redirects, skip_errors, public, screenshot, details, edges

Значение type или truetype	Тип проверки
1	HTTP HEAD
2	HTTP GET
3	HTTPS HEAD
4	HTTPS GET
5	FTP
6	FTPS
7	HTTP POST
8	HTTPS POST
11	PING
12	DNS A
13	DNS MX
14	DNS CNAME
15	DNS SOA
16	HTTP LOAD IE
17	HTTPS LOAD IE
18	HTTP LOAD Chrome
19	HTTPS LOAD Chrome
20	HTTP LOAD FX
21	HTTPS LOAD FX

Значение frequency	Частота проверки
0	Раз в сутки
8	Раз в 12 часов
7	Раз в 6 часов
6	Раз в 3 часа
1	Раз в час
2	Раз в 30 минут
3	Раз в 10 минут
4	Раз в 5 минут
5	Раз в минуту

Для действия add в случае успеха будет возвращен ID проверки в теге url.

Действие remove

Удаляет проверку

http://webopulsar.ru/api/wp.php?key=APIKEY&action=pause&url=URLID

Обязательных параметра три - key, action, url - если их не задать, то выведется ошибка.

APIKEY - ключ API, его можно посмотреть для каждого аккаунта на странице webopulsar.ru/account/ (внизу страницы).

URLID - ID проверки, его можно посмотреть на странице статистики проверок (выводится как параметр в экспортных данных (CSV, HTML, WIZ) - url_id - и как якорь блока проверки id="check-URLID").

Действие pause и restore

Ставит проверку на паузу (pause) или восстанавливает (restore)

http://webopulsar.ru/api/wp.php?key=APIKEY&action=pause&url=URLID

Обязательных параметра три - key, action, url - если их не задать, то выведется ошибка.

APIKEY - ключ API, его можно посмотреть для каждого аккаунта на странице webopulsar.ru/account/ (внизу страницы).

URLID - ID проверки, его можно посмотреть на странице статистики проверок (выводится как параметр в экспортных данных (CSV, HTML, WIZ) - url_id - и как якорь блока проверки id="check-URLID").

Возвращаемый формат данных (XML):

<status>OK</status>

Коды ошибок

1 - неверный ключ API, верный ключ указан на странице аккаунта.

2 - неверный ключ API, обратитесь в техническую поддержку по адресу pulsar@webo.name.

3 - недостаточно средств на балансе для проведения изменений.

4 - неверный параметр action, укажите action из списка поддерживаемых.

5 - неверный ID проверки (URLID), выберите верный со страницы проверки.

6 - не удается подключиться к серверу статистики, попробуйте еще раз.

7 - не удается синхронизировать изменения, попробуйте еще раз.