Начать бесплатно
Войти
Статьи

Функции статей/базы знаний.


Запрос


get-articles

Переводит строку на указанный язык. Эта функция работает только для front-end переводов.


Параметры

token
Обязательно* 		Токен администратора. 
function
Обязательно* 		Укажите get-articles. 
id
 Идентификатор статьи. Чтобы получить идентификаторы статей, выполните этот метод без аргументов. По умолчанию: -1. 
count
 Максимальное количество возвращаемых статей. По умолчанию: все. 
full
 Булевое значение. Установите true, чтобы получить полное содержание статьи. По умолчанию: false. 
categories
 Установите true, чтобы получить массив всех категорий. В таком случае ответ будет двойным массивом: первый элемент - статьи, второй элемент - категории. Установите идентификатор категории, чтобы получить только статьи данной категории. По умолчанию: false. 
articles_language
 Получите статьи на указаном языке. Если статей нет на указанном языке, будут возвращены статьи на языке по умолчанию. Установите значение all, чтобы получить все переводы. По умолчанию: false.

Ответ

{
"success": true,
"response": [
{
"id": "6P2Oq",
"title": "Что нового в API V2?",
"content": "API V2 - это новая версия нашего API...",
"link": "https://stepchat.io",
"categories": ["K92kl"]
},
{
"title": "Следует ли мне перейти на новую систему?",
"content": "Да. Самая новая версия системы действий ...",
"link": "https://stepchat.io",
"id": "qf7kD",
"categories": ["ols85"]
},
...
]
}

Ответ

{
"success": true,
"response": {
"id": "6P2Oq",
"title": "Что нового в API V2?",
"content": "API V2 - это новая итерация нашего разработчического API. Новый API интегрирует...",
"link": "https://stepchat.io",
"categories": ["K92kl"]
}
}


Запрос


save-articles

Сохраняет все статьи. Данная функция удаляет все существующие статьи и заменяет их на статьи из предоставленного массива.


Параметры

token
Обязательно* 		Токен администратора. 
function
Обязательно* 		Укажите save-articles. 
articles
Обязательно* 		Массив со статьями. Используйте API get-articles, чтобы получить массив статей. Синтаксис массива: {"articles": [{"id": "", "title": "", "content": "", "link": "", "categories": []}, ...]}. 
translations
 Массив с переводами статей. Используйте API get-articles, чтобы получить массив статей. Синтаксис массива: { "es": [{"id": "", "title": "", "content": "", "link": "", "categories": []}, ...], "it": [...], ...}.

Ответ

{
"success": true,
"response": true
}


Запрос


search-articles

Сохраняет все статьи. Данная функция удаляет все существующие статьи и заменяет их на статьи из предоставленного массива.


Параметры

token
Обязательно* 		Токен администратора. 
function
Обязательно* 		Укажите search-articles. 
search
Обязательно* 		Строка поиска по заголовку и содержанию. 
articles_language
 Поиск статей на указаном языке. Если статей нет на указанном языке, будут возвращены статьи на языке по умолчанию. Установите значение all, чтобы получить все переводы. По умолчанию: false.

Ответ

{
"success": true,
"response": [
{
"id": "6P2Oq",
"title": "Что нового в API V2?p",
"content": "API V2 - это новая итерация нашего API ...",
"link": "https://stepchat.io",
"categories": ["K92kl"]
},
{
"title": "Следует ли мне перейти на новый API?",
"content": "Да. Самая новая версия (V2) Actions ...",
"link": "https://stepchat.io",
"id": "qf7kD",
"categories": ["K92kl"]
},
...
]
}

Возвращает {"success": true, "response": []}, если статьи не найдены.


Запрос


get-articles-categories

Возвращает массив со всеми категориями статей.


Параметры

token
Обязательно* 		Токен администратора. 
function
Обязательно* 		Укажите get-articles-categories.

Ответ

{
"success": true,
"response": [
{
"id": "Nv9PG",
"title": "Бизнес"
},
{
"id": "csPVh",
"title": "Путешествия"
},
{
"id": "pl5S7",
"title": "Финансы"
},
...
]
}


Запрос


save-articles-categories

Сохраняет или обновляет массив категорий статей.


Параметры

token
Обязательно* 		Токен администратора. 
function
Обязательно* 		Укажите save-articles-categories. 
categories
Обязательно* 		Массив категорий. Синтаксис массива: [ { "id": "123456", "title": "Название категории" }, { "id": "123456", "title": "Название категории" }, ...]. Получите существующий массив категорий с помощью метода get-articles-categories.

Ответ

{
"success": true,
"response": true
}


Запрос


article-ratings

Сохраняет или обновляет массив категорий статей.


Параметры

token
Обязательно* 		Токен администратора. 
function
Обязательно* 		Укажите article-ratings. 
article_id
Обязательно* 		ID статьи. 
rating
Обязательно* 		Оценка для добавления. Введите 1 для положительной оценки или 0 для отрицательной. Если аргумент задан, метод добавит оценку, в противном случае вернет уже существующие оценки. По умолчанию: false.

Ответ

{
"success": true,
"response": "[-1, 1, 1, -1]"
}

Возвращает true, если аргумент оценки задан.