Описание API метода CleanTalk Anti-Spam "monitoring_services_add"

Этот метод используется для добавления новых URL-адресов для мониторинга веб-сайтов. Чтобы он работал, у пользователя должна быть активная лицензия на мониторинг с оставшимися свободными сервисами.

Запрос

Пример данных JSON

{
  "method_name": "monitoring_services_add",
  "user_token": "your_user_token",
  "URL": "https://cleantalk.org",
  "http_method": "GET",
  "checks_interval": "120",
  "email_notification_delay": "900",
  "checkpoints": "1,18"
}

Обработка данных

Необходимая информация об обработке данных.

Параметр	Объяснение
HTTP Метод	GET или POST
Формат данных	JSON
URL	https://api.cleantalk.org

Обязательные параметры

Данные параметры обязательны.

Параметр	Объяснение
method_name	Имя метода, должно быть "monitoring_services_add".
user_token	Ваш токен. Для получения токена зарегистрируйте аккаунт здесь
URL	URL-адрес ресурса для мониторинга

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

Эти параметры можно использовать для настройки вашего монитора.

Параметр	Объяснение
http_method	Метод, который будет использоваться для извлечения данных из контрольных точек. Поддерживаемые типы - HEAD и GET
check_interval	Частота проверок в секундах. Возможные значения: 60, 120, 180, 300, 600, 900, 1800, 3600
email_notification_delay	Задержка отправки уведомления по электронной почте в секундах. Возможные значения: 0, 60, 300, 900, 1800, 3600
checkpoints	Идентификаторы конкретных контрольных точек, которые будут использоваться при мониторинге данной службы (не более 2 одновременно). Список контрольных точек: 1: Frankfurt 5: Oregon 6: Sydney 8: Cape Town 10: Tokyo 12: Monreal 14: São Paulo 18: N. California 20: Hong Kong 22: London 24: Northern Virginia

Ответ

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

Ответ сервера не зависит от платформы.

{
  "data": {
    "monitors": {
      "0": {
        "monitor_id": 123,
        "operation_status": "SUCCESS"
      },
      "1": {
        "operation_status": "FAILED'",
        "operation_message": "Same URL already exists in your list. Please choose another one",
        "operation_code": "6"
      }
    }
  }
}

Разъяснение ответов

Ключ	Объяснение
monitors	Список мониторов с результатами работы
monitor_id	Идентификатор монитора, предоставляемый в случае успешного выполнения операции
operation_status	Статус операции, SUCCESS или FAILED
operation_message	Описание ошибки в случае сбоя
operation_code	Код ошибки в случае сбоя

Примеры кода

Используя Wget

Пример CLI

wget -O- https://api.cleantalk.org/?method_name=monitoring_services_add&URL=cleantalk.org&user_token=someTokenValue

Используя PHP

PHP бакенд

                                
                                    
                                
                               <?php

$url = "https://api.cleantalk.org/?method_name=monitoring_services_add&URL=cleantalk.org&user_token=someTokenValue";
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); // Use true in production

$response = curl_exec($ch);
$responseString = "Response:\n" . $response";

curl_close($ch);

Ссылки по теме

Доступные функции, связанные с этим методом:

Uptime Monitoring