Как подключить API-методы для работы с настройками сайта
Интерфейс для работы доступен по ссылке cleantalk.org/my/services_templates
Содержание:
Общие сведения
Метод services_templates_get
Метод services_templates_add
Метод services_templates_update
Метод services_templates_delete
Метод services_templates_set
Общие сведения
Протокол - https
Имя хоста - api.cleantalk.org
Метод services_templates_get
Входные параметры
Методы передачи параметров GET или POST.
Обязательные
method_name допустимые значения: services_templates_get
user_token или auth_key допустимые значения: user_token можно получить в ПУ на странице профиля пользователя, auth_key можно использовать от любой активной услуги продуктов Анти-Спам или Безопасность сайта
Пример:
https://api.cleantalk.org/?method_name=services_templates_get&user_token=USER_TOKEN
Необязательные
search[field] поиск по полю field, доступные значения field:
- template_id - integer, ID шаблона
- product_id - integer, ID продукта, допустимые значения: 1 - Анти-Спам, 4 - Безопасность сайта
- name - string, название шаблона, полное или частичное совпадение
- created - string, дата создания, точное соответствие. Формат: Y-m-d H:i:s
- created[gte] - string, дата создания начало периода. Формат: Y-m-d
- created[lte] - string, дата создания конец периода. Формат: Y-m-d
- updated - string, дата обновления, точное соответствие. Формат: Y-m-d H:i:s
- updated[gte] - string, дата обновления начало периода. Формат: Y-m-d
- updated[lte] - string, дата обновления конец периода. Формат: Y-m-d
- service_id_last_used - integer, ID услуги, к которой применен шаблон в последний раз
- set_as_default - integer, признак шаблона по умолчанию. Допустимые значения: 0 - нет, 1 - да.
- options_cloud - integer, признак наличия настроек ПУ. Допустимые значения: 0 - нет, 1 - да.
- options_site - integer, признак наличия настроек сайта. Допустимые значения: 0 - нет, 1 - да.
start смещение для первой записи списка, 0 по умолчанию
length ограничение количества записей в ответе, 0 по умолчанию (без ограничений).
order[0][dir] направление сортировки записей в списке, допустимые значения: asc, desc
order[0][column] индекс поля, по которому происходит сортировка записей
columns[0][data] название поля для сортировки записей, допустимые значения: template_id, product_id, name, created, updated, service_id_last_used, set_as_default
draw произвольное значение, будет передано в ответе, для асинхронных запросов.
Пример:
https://api.cleantalk.org/?method_name=services_templates_get&auth_key=AUTH_KEY&draw=1&search[created][gte]=2021-01-01
Выходные параметры
recordsTotal кол-во записей без учета фильтрации
recordsFiltered кол-во записей с учетом фильтрации
draw произвольное значение, это значение из входных параметров
operation_status статус операции, допустимые значения: SUCCESS, FAILED
operation_message текст ошибки
data массив записей:
- template_id идентификатор записи
- product_id тип продукта
- name имя шаблона
- options_cloud настройки ПУ
- options_site настройки сайта
- created время создания записи
- updated время обновления записи
- service_id_last_used ID услуги, к которой применен шаблон в последний раз
- user_id ID клиента
- set_as_default признак шаблона по умолчанию
Пример:
{"draw":1,"recordsTotal":3,"recordsFiltered":3,"data":[{"template_id":108,"product_id":1,"name":"for_antispam","options_cloud":"{"response_lang":"es","stop_list_enable":"0","move_to_spam_enable":"1","allow_links_enable":"1","send_log_to_email":"1","server_response":null,"server_response_combine":"0","logging_restriction":"1"}","options_site":"","created":"2021-02-26 17:27:13","updated":"2021-02-26 17:27:13","service_id_last_used":null,"user_id":577205,"set_as_default":1},{"template_id":110,"product_id":4,"name":"for_security","options_cloud":"{"notify_admin_login":"1","auto_whitelist_owner_ip":"1","ct_in_list_db":"1","2fa_enable":"0","backend_logs_enable":"1"}","options_site":"","created":"2021-02-26 17:42:41","updated":"2021-02-26 17:42:41","service_id_last_used":null,"user_id":577205,"set_as_default":1}],"operation_message":"","operation_status":"SUCCESS"}
Возможные ошибки
- Unknown access key.
- User token not found
- Service disabled, please go to Dashboard https://cleantalk.org/my. Wrong start
- Too big start
- Wrong length
- Wrong columns
- Wrong order
- Wrong columns or order
Метод services_templates_add
Входные параметры
Методы передачи параметров GET или POST.
Обязательные
method_name допустимые значения: services_templates_add
auth_key допустимые значения: можно использовать от любой активной услуги продуктов Анти-Спам или Безопасность сайта. Шаблон будет создан для соответствующего продукта
name допустимые значения: уникальная строка длиной не более 127 символов
Пример:
https://api.cleantalk.org/?method_name=services_templates_add&auth_key=AUTH_KEY&name=test
Необязательные
options_cloud настройки ПУ, если параметр не передан, то настройки собираются из услуги, которой относится auth_key
optoins_site настройки сайта, если параметр не передан, то настройки копируются из шаблона по умолчанию для продукта, к которому относится auth_key
set_as_default признак шаблона по умолчанию
Пример:
https://api.cleantalk.org/?method_name=services_templates_add&auth_key=AUTH_KEY&name=test&set_as_default=1
Выходные параметры
data массив записей:
- template_id идентификатор записи
- product_id тип продукта
- created время создания записи
- updated время обновления записи
- operation_status статус операции, допустимые значения: SUCCESS, FAILED
- operation_message текст ошибки
Пример:
{"data":[{"template_id":7,"product_id":4,"created":"2021-03-25 09:05:35","updated":"2021-03-25 09:05:35","operation_status":"SUCCESS","operation_message":""}]}
Возможные ошибки
- Unknown access key.
- Service disabled, please go to Dashboard https://cleantalk.org/my. Wrong start
- Please fill in the name
- Data too long for name
- The name must be unique
- Please fill in the options_cloud or optoins_site
- Wrong options_cloud
- Wrong options_cloud in template.
- Wrong optoins_site
- Too many templates
Метод services_templates_update
Входные параметры
Методы передачи параметров GET или POST.
Обязательные
method_name допустимые значения: services_templates_update
auth_key допустимые значения: можно использовать от любой активной услуги продуктов Анти-Спам или Безопасность сайта. Шаблон будет создан для соответствующего продукта
template_id допустимые значения: ID шаблона для обновления
Необязательные
(хотя бы один из параметров надо передать)
name допустимые значения: уникальная строка длиной не более 127 символов
options_cloud настройки ПУ
optoins_site настройки сайта
set_as_default признак шаблона по умолчанию
Пример:
https://api.cleantalk.org/?method_name=services_templates_update&auth_key=AUTH_KEY&template_id=7&name=test7&set_as_default=1
Выходные параметры
data массив записей:
- template_id идентификатор записи
- operation_status статус операции, допустимые значения: SUCCESS, FAILED
- operation_message текст ошибки
Пример:
{"data":[{"template_id":7,"operation_message":"","operation_code":"","operation_status":"SUCCESS"}]}
Возможные ошибки
- Unknown access key.
- Service disabled, please go to Dashboard https://cleantalk.org/my. Wrong start
- Wrong template_id
- Template not found
- Please fill in the name or options_cloud or options_site or set_as_default
- Wrong name
- Data too long for name
- The name must be unique
- Wrong options_cloud
- Wrong options_cloud in template.
- Wrong options_site
- This method does not support service by authkey
Метод services_templates_delete
Входные параметры
Методы передачи параметров GET или POST.
Обязательные
method_name допустимые значения: services_templates_update
user_token или auth_key допустимые значения: user_token можно получить в ПУ на странице профиля пользователя, auth_key можно использовать от любой активной услуги продуктов Анти-Спам или Безопасность сайта
template_ids допустимые значения: массив ID шаблонов или строка ID шаблонов, разделенные запятыми.
Пример:
https://api.cleantalk.org/?method_name=services_templates_delete&user_token=USER_TOKEN&template_ids=1,2
https://api.cleantalk.org/?method_name=services_templates_delete&auth_key=AUTH_KEY&template_ids[]=1&template_ids[]=2
Выходные параметры
data массив записей:
- number_of_delete_templates идентификатор удаленной записи
- operation_status статус операции, допустимые значения: SUCCESS, FAILED
- operation_message текст ошибки
Пример:
{"data":[{"number_of_delete_templates":1,"operation_status":"SUCCESS","operation_message":"","operation_code":""},{"number_of_delete_templates":2,"operation_status":"FAILED","operation_message":"Template not found","operation_code":21}]}
Возможные ошибки
- Unknown access key.
- User token not found
- Service disabled, please go to Dashboard https://cleantalk.org/my. Wrong start
- Wrong template_ids
- Wrong template_ids. Array of integer
Метод services_templates_set
Входные параметры
Методы передачи параметров GET или POST.
Обязательные
method_name допустимые значения: services_templates_set
user_token или auth_key допустимые значения: user_token можно получить в ПУ на странице профиля пользователя, auth_key можно использовать от любой активной услуги продуктов Анти-Спам или Безопасность сайта
services_ids допустимые значения: массив ID услуг или строка ID услуг, разделенные запятыми.
template_id допустимые значения: ID шаблона.
mode тип настроек, допустимые значения:
- CLOUD - установить настройки только для ПУ
- SITE - установить настройки только для сайта
- BOTH - установить настройки обоих типов
Пример:
https://api.cleantalk.org/?method_name=services_templates_set&auth_key=AUTH_KEY&services_ids=840411,843291&template_id=3&mode=cloud
https://api.cleantalk.org/?method_name=services_templates_set&user_token=USER_TOKEN&services_ids[]=840411&template_id=10&mode=cloud
Выходные параметры
data массив записей:
- number_of_set_services идентификатор измененной услуги
- operation_status статус операции, допустимые значения: SUCCESS, FAILED
- operation_message текст ошибки
Пример:
{"data":[{"number_of_set_services":840411,"operation_status":"FAILED","operation_message":"Wrong product_id","operation_code":21},{"number_of_set_services":843291,"operation_status":"SUCCESS","operation_message":"","operation_code":""}]}
Возможные ошибки
- Unknown access key.
- User token not found
- Service disabled, please go to Dashboard https://cleantalk.org/my. Wrong start
- Wrong services_ids
- Wrong services_ids. Array of integer
- Wrong template_id
- Wrong mode
- Empty options_cloud
- Wrong options_cloud in template.
- Empty options_site
Если Вы не нашли ответ на интересующий вас вопрос, то предлагаем вам связаться с нашими специалистами. [ https://cleantalk.org/my/support/open ].