Авторизация

Содержит методы работы с авторизацией пользователей

Авторизация

Метод производит авторизацию пользователя внутри системы, создает специальную сессию и возвращет токен авторизации для доступа к остальным методам

Параметры запроса

Атрибут Тип Обязательное Описание
email* string Да E-mail пользователя
password* string Да Пароль пользователя
policy* boolean Да Принятие политики конфиденциальности
remember boolean Запомнить сессию - продление сессии до 7 дней (по стандарту 12 часов)
keycloak boolean Отметка об авторизации через Keycloak
noip boolean Запомнить IP адрес пользователя
ttl int Время жизни сессии

Ошибки

Код Описание
40301 Неверный логин или пароль
40302 Аккаунт пользователя отключён
40303 Аккаунт пользователя не активирован

Пинг

ping

Обновление профиля

Метод обновляет информацию текущего авторизованного пользователя

Пользователи

Список пользователей

Метод выведет список пользователей на основе указанных фильтров.

Параметры запроса

Атрибут Тип Обязательное Описание
page integer Номер порции данных
limit integer Размер порции. Максимум 50 записей

Создание контакта пользователя

Метод позволяет добавить контакт владельцу токена

Параметры запроса

Атрибут Тип Обязательное Описание
type* tel, skype, email, url, telegram, fb, vk, ok, location, linkedin, instagram Да Тип контакта
data* string Да Вносимые данные

Удаление контакта пользователя

Метод позволяет удалить контакт по id

Параметры запроса

Атрибут Тип Обязательное Описание
id* integer Да id контакта

Пользователь

Метод выведет информацию о пользователе

Параметры запроса

Атрибут Тип Обязательное Описание
id* integer Да id пользователя
contacts boolean Подробные данные о контактах
team boolean Подробные данные о команде
department boolean Подробные данные об отделе

Список пользователей

Метод выведет список пользователей на основе заданных фильтров

Параметры запроса

Атрибут Тип Обязательное Описание
department integer id отдела
team integer id команды
company_role integer id роли
status active, invite, blocked Статус пользователя

Приглашение для пользователя

При вызове данного метода пользователю будет направлено специальное почтовое уведомление с приглашением и ссылкой на активацию аккаунта

Список пользователей

Обновление пользователя

Начисление валюты пользователю

Удаление пользователя

Создание пользователя

Упрощённый список пользователей

Роли

roles.create

roles.delete

roles.getList

roles.setUsers

roles.update

Отделы

departments.create

departments.delete

departments.get

departments.getTree

departments.setUsers

departments.structure

departments.update

Команды

teams.create

teams.delete

teams.get

teams.getList

teams.setUsers

teams.update

Должности

Нет методов в данной группе

Достижения

Присвоение достижения пользователям

Создание достижения

achievements.delete

Список пользователей с достижением

achievements.get

achievements.getEvents

achievements.getList

achievements.getUsers

achievements.read

Удаление достижения у пользователя

Удаление достижения у всех пользователей

achievements.simpleList

achievements.update

achievements.updateAccessList

Герой

v2.hero

v2.hero.{n}.invite

v2.hero.{n}.levels.{n}.update

v2.hero.{n}.levels.{n}.delete

v2.hero.{n}.levels.add

v2.hero.{n}.users.{n}.delete

v2.hero.add

Герой пользователя

sdfsdfsd

Магазин

shop.addAtributes

shop.addCategory

shop.addProductCategory

shop.addUserCategory

shop.adminListOrders

shop.adminListOrders

shop.cancelOrder

shop.createOrder

shop.createProduct

shop.deleteProduct

shop.dellAtributes

shop.dellCategory

shop.editAtributes

shop.editCategory

shop.getAtributes

shop.getCategory

shop.listOrders

Список товаров

Магазин. Список продуктов.

shop.setOrderStatus

shop.simpleList

shop.toArchive

shop.updateProduct

shop.upsortCategory

Галерея

media.addMedia

media.createAlbum

media.deleteAlbum

media.deleteMedia

media.getAlbum

Список альбомов

Галерея. Список альбомов.

media.updateAlbum

media.updateMedia

Контент

content.create

content.delete

content.get

content.index

content.update

Рейтинг

games.addGroup

games.addUsersGameGift

games.clone

games.create

games.delete

games.finish

games.get

games.index

games.listUsers

games.simpleList

games.start

games.start

games.update

rating.get

rating.getRatingUser

Опросы

polls.create

polls.delete

polls.get

polls.getPollResult

polls.index

polls.status

polls.submit

polls.update

Задания

Список заданий

Метод вернет список всех заданий для администрирования

Параметры запроса

Атрибут Тип Обязательное Описание
per int, null Количество на страницу
page int, null Номер страницы
active boolean Только активные или не активные задания
text string Поисковая фраза
tags int[] Массив идентификаторов тегов

Список заданий для пользователя

Метод вернет список всех заданий, назначенных и доступных пользователю

Параметры запроса

Атрибут Тип Обязательное Описание
per int, null Количество на страницу
page int, null Номер страницы
status actual, invite, accept, reject, moderate, rework, complete, fail, null Статус выполнения
active boolean Только активные или не активные задания

Список заданий на проверке

Метод вернет список заданий, которые находятся на проверке и требуют действий модератора

Параметры запроса

Атрибут Тип Обязательное Описание
per int, null Количество на страницу
page int, null Номер страницы
user int, null Идентификатор пользователя
department int, null Идентификатор отдела
team int, null Идентификатор команды
task int, null Идентификатор задания
tags int[] Массив идентификаторов тегов

Упрощённый список заданий

Метод вернет упрощённый список заданий с минимальным количеством информации, для дальнейшего переиспользования, например, в списках или селекторах выбора

Создание задания

Метод позволяет создать новое задание

Параметры запроса

Атрибут Тип Обязательное Описание
user int, null Идентификатор пользователя (автора), по умолчанию текущий
responsible int, null Идентификатор пользователя (ответственного), по умолчанию текущий
title* string Да Заголовок задания
description string, null Описание задания
image string, null Идентификатор (uuid) изображения (обложки)
coins int, null Количество наградной валюты
exp int, null Количество наградного опыта
scores {rating: int, amount: int}[] Массив с количеством наградных очков для каждого из рейтингов, здесь rating - идентификатор рейтинга, amount - количество очков
achievement int, null Идентификатор наградного достижения
active int Опубликовано или не опубликовано
edate string, null Дата автоматического завершения
timeout int, null Время в секундах до автоматического завершения
repeat int Повторяемое задание
repeat_delay int, null Задержка перед повтором в секундах
repeat_limit int, null Количество повторений
attachment string, null Идентификатор (uuid) вложения
type text, test, poll, dialog Тип задания, по умолчанию text
test int, null Идентификатор теста
poll int, null Идентификатор опроса
dialog int, null Идентификатор диалогового тренажера
currencies?: { [currencyId: number]: number } null
tags string[] Массив названий тегов

Обновление задания

Метод позволяет обновить данные задания при его редактировании

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания
user int, null Идентификатор пользователя (автора), по умолчанию текущий
responsible int, null Идентификатор пользователя (ответственного), по умолчанию текущий
title* string Да Заголовок задания
description string, null Описание задания
image string, null Идентификатор (uuid) изображения (обложки)
coins int, null Количество наградной валюты
exp int, null Количество наградного опыта
scores {rating: int, amount: int}[] Массив с количеством наградных очков для каждого из рейтингов, здесь rating - идентификатор рейтинга, amount - количество очков
achievement int, null Идентификатор наградного достижения
active int Опубликовано или не опубликовано
edate string, null Дата автоматического завершения
timeout int, null Время в секундах до автоматического завершения
repeat int Повторяемое задание
repeat_delay int, null Задержка перед повтором в секундах
repeat_limit int, null Количество повторений
attachment string, null Идентификатор (uuid) вложения
type text, test, poll, dialog Тип задания, по умолчанию text
test int, null Идентификатор теста
poll int, null Идентификатор опроса
dialog int, null Идентификатор диалогового тренажера
currencies?: { [currencyId: number]: number } null
tags string[] Массив названий тегов

Удаление задания

Метод удаляет задание из системы. Заданию присваивается дата удаления и более нигде не отображается

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания

Удаление списка заданий

Метод удаляет набор заданий по их идентификатором. Каждому заданию устанавливается дата удаления и более эти задания нигде не отображаются

Параметры запроса

Атрибут Тип Обязательное Описание
ids* int[] Да Массив идентификаторов заданий

Клонирование задания

Метод позволяет сделать полную копию задания. Скопируются все атрибуты и поля задания. Если задание было в архиве, оно активируется автоматически.

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания

Информация о задании

Метод вернет полную информацию о конкретном задании

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания
user number, null Идентификатор пользователя (по умолчанию текущий)

Информация о задании из обучения

Метод вернет полную информацию о конкретном задании, находящемся в курсе

Параметры запроса

Атрибут Тип Обязательное Описание
task* int Да Идентификатор задания

Список участников задания

Метод вернет список пользователей, которым назначено задание для выполнения

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания
per int, null Количество на страницу
page int, null Номер страницы
text string Поисковая фраза
status invite, accept, reject, moderate, rework, complete, fail, null Статус выполнения

Приглашение участников в задание

Метод позволяет добавить пользователей/отделы/команды в список приглашенных для выполнения заданий

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания
departments int[] Массив идентификаторов отделов
teams int[] Массив идентификаторов команд
users int[] Массив идентификаторов пользователей

Удаление участника

Метод удалит выбранного участника, приглашенного для выполнения задания

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания
user* int Да Идентификатор пользователя

Удаление всех участников из задания

Метод удалил всех участников, приглашенных для выполнения задания

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания

Смена статуса задачи администратором

Метод даёт возможность изменить статус задания со стороны модератора. В основном используется при возвращении на доработку или подтверждении выполнения задания

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания
user* int Да Идентификатор пользователя
status* invite, accept, reject, moderate, rework, complete, fail, null Да Статус выполнения
comment string, null Текст комментария
attachment string, null Идентификатор (uuid) вложения

Смена статуса задачи пользователем

Метод даёт возможность изменить статус задания со стороны пользователя. В основном необходим для таких действий пользователя, как: принять, отказаться, отправить на модерацию.

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания
status* invite, accept, reject, moderate, rework, complete, fail Да Статус задания
comment string, null Текст комментария
attachment string, null Идентификатор (uuid) вложения

Список историй выполнения заданий

Метод вернет список заданий, которые были назначены пользователям для отслеживания их выполнения

Параметры запроса

Атрибут Тип Обязательное Описание
per int, null Количество на страницу
page int, null Номер страницы
user int, null Идентификатор пользователя (исполнителя)
responsible int, null Идентификатор пользователя (ответственного)
task int, null Идентификатор задания
tags int[] Массив идентификаторов тегов
status invite, accept, reject, moderate, rework, complete, fail, null Статус выполнения

История выбранного задания

Метод вернет подробную информацию об истории прохождения задания пользователем

Параметры запроса

Атрибут Тип Обязательное Описание
id* int Да Идентификатор задания

Конкурсы

contests.clone

contests.create

contests.delete

contests.get

contests.historyContest

contests.index

contests.indexContestUsers

contests.invite

contests.moderateIndex

contests.moderationHistory

contests.removeUsersAll

contests.simpleList

contests.update

contests.userIndex

contests.userIndex

contests.userStatus

Квесты

quests.acceptQuest

quests.checkTask

quests.clone

Создание квеста

Создание квестового задания

quests.delete

Удаление квестового задания

quests.doneTask

История задания

quests.index

quests.indexCheck

quests.indexQuestUserTasks

Список заданий квеста

quests.indexUsersQuests

Приглашение участников в квест

quests.moderationHistory

Удаление участника из квеста

Удаление всех участников квеста

quests.simpleListQuests

Старт задания

quests.update

Обновление квестового задания

База знаний

kb.create

kb.delete

kb.fav

kb.get

kb.index

kb.publish

kb.simpleList

kb.unfav

kb.update

Обучение

levels.create

levels.delete

levels.index

levels.update

professions.create

professions.delete

professions.index

professions.update

programs.changeProgram

programs.cloneProgram

programs.create

programs.create

programs.createNode

programs.delete

programs.deleteNode

programs.get

programs.index

programs.indexNodes

programs.invite

programs.kick

programs.kickAll

programs.moveNode

programs.relations

programs.tree

programs.update

programs.updateNode

programs.users

training.available

training.current

training.index

training.next

training.progress

training.setcurrent

training.status

Заявки

forms.create

forms.delete

forms.get

forms.getApplication

forms.index

forms.indexApplications

forms.setApplicationStatus

forms.simpleList

forms.submit

forms.update

Тесты

testing.answer

testing.cloneQuestion

testing.cloneQuestion

testing.createAnswer

testing.createQuestion

testing.createTest

testing.deleteAnswer

testing.deleteQuestion

testing.deleteTest

testing.get

testing.index

testing.indexAnswers

testing.indexQuestions

testing.next

testing.result

testing.results

testing.simpleList

testing.start

testing.updateAnswer

testing.updateQuestion

testing.updateTest

Календарь

events.calendar

events.create

events.delete

events.update

Слайды

Нет методов в данной группе

Документы

docs.createFile

docs.createFolder

docs.createFolder

docs.delete

docs.get

docs.getList

docs.getList

docs.tree

docs.updateFile

docs.updateFolder

Интеграции

Нет методов в данной группе

Лог

v2.logging

v2.transactions.full

v2.transactions.full

Мои документы

Нет методов в данной группе

Диалоговый тренажер

Нет методов в данной группе

Комментарии

comments.create

comments.delete

comments.index

comments.restore

comments.vote

Уведомления

users.notifications.delete

users.notifications.index

users.notifications.read

users.notifications.readAll

Валюты

v2.currencies

v2.currencies.{n}.delete

v2.currencies.{n}.update

v2.currencies.add

Меню

v2.menu

v2.menu.{n}.update

v2.menu.{n}.delete

v2.menu.add

Загрузки

uploads.get

uploads.upload

Транзакции

v2.transactions

v2.translations

Теги

v2.tags

v2.tags.{n}.delete

v2.tags.add

Чекин

check.checkup