Описание методов API

Все методы API InstantCMS сгруппированные по компонентам.

Контент

Название	Описание
content.get_ctypes	Возвращает все типы контента.
content.get_datasets.CTYPE	Возвращает наборы для заданного типа контента.
content.get_categories.CTYPE	Возвращает категории для заданного типа контента.
content.get_fields.CTYPE	Возвращает поля записей для заданного типа контента.
content.get_props.CTYPE	Возвращает свойства категорий для заданного типа контента.
content.get_props_values.CTYPE	Возвращает значения свойств записи для заданного типа контента.
content.get_folders.CTYPE	Возвращает папки записей для заданного типа контента.
content.get.CTYPE	Возвращает записи для заданного типа контента.
content.get_item.CTYPE	Возвращает одну запись для заданного типа контента.
content.update_item.CTYPE	Редактирует одну запись для заданного типа контента.
content.add_item.CTYPE	Добавляет запись в заданный тип контента.

Примечание. CTYPE - название типа контента, например news, board, articles и т.д.

Название	Описание
auth.signup_fields	Получает имена полей, обязательных для регистрации.
auth.signup	Регистрирует нового пользователя.
auth.confirm	Завершает регистрацию нового пользователя, начатую методом auth.signup.
auth.restore	Отправка запроса на восстановление пароля пользователя.
auth.login	Авторизация пользователя стандартным способом (используются cookie).
auth.logout	Разавторизация пользователя.

Название	Описание
users.get	Возвращает информацию о пользователях.
users.get_sig	Возвращает SIG и csrf_token.
users.add	Добавляет пользователя.
users.get_groups	Возвращает все группы пользователей.
users.add_to_groups	Добавляет пользователя в группы.
users.remove_from_groups	Убирает пользователя из групп.

Название	Описание
wall.get	Возвращает список записей со стены пользователя или группы.

Название	Описание
messages.send	Отправляет сообщение.
messages.delete_contact	Удаляет контакт.
messages.delete_mesages	Удаляет сообщения.
messages.delete_notice	Удаляет уведомления.
messages.forgive	Прекращает игнорирование контакта.
messages.ignore	Включает игнорирование контакта.
messages.get	Возвращает список сообщений.
messages.get_notices	Возвращает список уведомлений.
messages.readed	Помечает сообщения как прочитанные.
messages.restore_mesage	Восстанавливает сообщение.

Название	Описание
geo.get	Возвращает список стран/регионов/городов.
geo.get_current_country	Возвращает данные по текущей стране пользователя, если она была определена по его ip адресу.

Название	Описание
images.get_presets	Возвращает список всех доступных пресетов.
images.upload	Загружает изображение.

Название	Описание
execute	Универсальный метод, который позволяет запускать последовательность других методов, сохраняя промежуточные результаты и возвращая их все в одном ответе.

Назад к описанию компонента InstantCMS JSON API