Документация InstantCMS - manual:components:api
для администраторов и разработчиков
https://docs.instantcms.ru/
2026-11-13T00:18:01+00:00
Документация InstantCMS
https://docs.instantcms.ru/
https://docs.instantcms.ru/_media/wiki/dokuwiki.svg
-
text/html
2019-04-08T20:44:20+00:00
Anonymous (anonymous@undisclosed.example.com)
Описание методов API
https://docs.instantcms.ru/manual/components/api/methods?rev=1554756260
<h1 class="sectionedit1" id="описание-методов-api">Описание методов API</h1>
<div class="level1">
<p>
Все методы <abbr title="Application Programming Interface">API</abbr> InstantCMS сгруппированные по компонентам.
</p>
</div>
<!-- EDIT{"target":"section","name":"\u041e\u043f\u0438\u0441\u0430\u043d\u0438\u0435 \u043c\u0435\u0442\u043e\u0434\u043e\u0432 API","hid":"\u043e\u043f\u0438\u0441\u0430\u043d\u0438\u0435-\u043c\u0435\u0442\u043e\u0434\u043e\u0432-api","codeblockOffset":0,"secid":1,"range":"1-147"} -->
<h2 class="sectionedit2" id="контент">Контент</h2>
<div class="level2">
<div class="table sectionedit3"><table class="inline">
<thead>
<tr class="row0">
<th class="col0"> Название </th><th class="col1"> Описание </th>
</tr>
</thead>
<tr class="row1">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-get_ctypes" class="wikilink1" title="manual:components:api:methods:content-get_ctypes" data-wiki-id="manual:components:api:methods:content-get_ctypes">content.get_ctypes</a> </td><td class="col1"> Возвращает все типы контента. </td>
</tr>
<tr class="row2">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-get_datasets" class="wikilink1" title="manual:components:api:methods:content-get_datasets" data-wiki-id="manual:components:api:methods:content-get_datasets">content.get_datasets.CTYPE</a> </td><td class="col1"> Возвращает наборы для заданного типа контента. </td>
</tr>
<tr class="row3">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-get_categories" class="wikilink1" title="manual:components:api:methods:content-get_categories" data-wiki-id="manual:components:api:methods:content-get_categories">content.get_categories.CTYPE</a> </td><td class="col1"> Возвращает категории для заданного типа контента. </td>
</tr>
<tr class="row4">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-get_fields" class="wikilink1" title="manual:components:api:methods:content-get_fields" data-wiki-id="manual:components:api:methods:content-get_fields">content.get_fields.CTYPE</a> </td><td class="col1"> Возвращает поля записей для заданного типа контента. </td>
</tr>
<tr class="row5">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-get_props" class="wikilink1" title="manual:components:api:methods:content-get_props" data-wiki-id="manual:components:api:methods:content-get_props">content.get_props.CTYPE</a> </td><td class="col1"> Возвращает свойства категорий для заданного типа контента. </td>
</tr>
<tr class="row6">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-get_props_values" class="wikilink1" title="manual:components:api:methods:content-get_props_values" data-wiki-id="manual:components:api:methods:content-get_props_values">content.get_props_values.CTYPE</a> </td><td class="col1"> Возвращает значения свойств записи для заданного типа контента. </td>
</tr>
<tr class="row7">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-get_folders" class="wikilink1" title="manual:components:api:methods:content-get_folders" data-wiki-id="manual:components:api:methods:content-get_folders">content.get_folders.CTYPE</a> </td><td class="col1"> Возвращает папки записей для заданного типа контента. </td>
</tr>
<tr class="row8">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-get" class="wikilink1" title="manual:components:api:methods:content-get" data-wiki-id="manual:components:api:methods:content-get">content.get.CTYPE</a> </td><td class="col1"> Возвращает записи для заданного типа контента. </td>
</tr>
<tr class="row9">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-get_item" class="wikilink1" title="manual:components:api:methods:content-get_item" data-wiki-id="manual:components:api:methods:content-get_item">content.get_item.CTYPE</a> </td><td class="col1"> Возвращает одну запись для заданного типа контента. </td>
</tr>
<tr class="row10">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-update_item" class="wikilink1" title="manual:components:api:methods:content-update_item" data-wiki-id="manual:components:api:methods:content-update_item">content.update_item.CTYPE</a> </td><td class="col1"> Редактирует одну запись для заданного типа контента. </td>
</tr>
<tr class="row11">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/content-add_item" class="wikilink1" title="manual:components:api:methods:content-add_item" data-wiki-id="manual:components:api:methods:content-add_item">content.add_item.CTYPE</a> </td><td class="col1"> Добавляет запись в заданный тип контента. </td>
</tr>
</table></div>
<!-- EDIT{"target":"table","name":"","hid":"table","secid":3,"range":"176-2157"} -->
<p>
Примечание. CTYPE - название типа контента, например news, board, articles и т.д.
</p>
</div>
<!-- EDIT{"target":"section","name":"\u041a\u043e\u043d\u0442\u0435\u043d\u0442","hid":"\u043a\u043e\u043d\u0442\u0435\u043d\u0442","codeblockOffset":0,"secid":2,"range":"148-2282"} -->
<h2 class="sectionedit4" id="авторизация-и-регистрация">Авторизация и регистрация</h2>
<div class="level2">
<div class="table sectionedit5"><table class="inline">
<thead>
<tr class="row0">
<th class="col0"> Название </th><th class="col1"> Описание </th>
</tr>
</thead>
<tr class="row1">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/auth-signup_fields" class="wikilink1" title="manual:components:api:methods:auth-signup_fields" data-wiki-id="manual:components:api:methods:auth-signup_fields">auth.signup_fields</a> </td><td class="col1"> Получает имена полей, обязательных для регистрации. </td>
</tr>
<tr class="row2">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/auth-signup" class="wikilink1" title="manual:components:api:methods:auth-signup" data-wiki-id="manual:components:api:methods:auth-signup">auth.signup</a> </td><td class="col1"> Регистрирует нового пользователя. </td>
</tr>
<tr class="row3">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/auth-confirm" class="wikilink1" title="manual:components:api:methods:auth-confirm" data-wiki-id="manual:components:api:methods:auth-confirm">auth.confirm</a> </td><td class="col1"> Завершает регистрацию нового пользователя, начатую методом auth.signup. </td>
</tr>
<tr class="row4">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/auth-restore" class="wikilink1" title="manual:components:api:methods:auth-restore" data-wiki-id="manual:components:api:methods:auth-restore">auth.restore</a> </td><td class="col1"> Отправка запроса на восстановление пароля пользователя. </td>
</tr>
<tr class="row5">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/auth-login" class="wikilink1" title="manual:components:api:methods:auth-login" data-wiki-id="manual:components:api:methods:auth-login">auth.login</a> </td><td class="col1"> Авторизация пользователя стандартным способом (используются cookie). </td>
</tr>
<tr class="row6">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/auth-logout" class="wikilink1" title="manual:components:api:methods:auth-logout" data-wiki-id="manual:components:api:methods:auth-logout">auth.logout</a> </td><td class="col1"> Разавторизация пользователя. </td>
</tr>
</table></div>
<!-- EDIT{"target":"table","name":"","hid":"table1","secid":5,"range":"2345-3351"} -->
</div>
<!-- EDIT{"target":"section","name":"\u0410\u0432\u0442\u043e\u0440\u0438\u0437\u0430\u0446\u0438\u044f \u0438 \u0440\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044f","hid":"\u0430\u0432\u0442\u043e\u0440\u0438\u0437\u0430\u0446\u0438\u044f-\u0438-\u0440\u0435\u0433\u0438\u0441\u0442\u0440\u0430\u0446\u0438\u044f","codeblockOffset":0,"secid":4,"range":"2283-3351"} -->
<h2 class="sectionedit6" id="пользователи">Пользователи</h2>
<div class="level2">
<div class="table sectionedit7"><table class="inline">
<thead>
<tr class="row0">
<th class="col0"> Название </th><th class="col1"> Описание </th>
</tr>
</thead>
<tr class="row1">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/users-get" class="wikilink2" title="manual:components:api:methods:users-get" rel="nofollow" data-wiki-id="manual:components:api:methods:users-get">users.get</a> </td><td class="col1"> Возвращает информацию о пользователях. </td>
</tr>
<tr class="row2">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/users_get_sig" class="wikilink1" title="manual:components:api:methods:users_get_sig" data-wiki-id="manual:components:api:methods:users_get_sig">users.get_sig</a> </td><td class="col1"> Возвращает SIG и csrf_token. </td>
</tr>
<tr class="row3">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/users-add" class="wikilink1" title="manual:components:api:methods:users-add" data-wiki-id="manual:components:api:methods:users-add">users.add</a> </td><td class="col1"> Добавляет пользователя. </td>
</tr>
<tr class="row4">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/users-get_groups" class="wikilink1" title="manual:components:api:methods:users-get_groups" data-wiki-id="manual:components:api:methods:users-get_groups">users.get_groups</a> </td><td class="col1"> Возвращает все группы пользователей. </td>
</tr>
<tr class="row5">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/users-add_to_groups" class="wikilink1" title="manual:components:api:methods:users-add_to_groups" data-wiki-id="manual:components:api:methods:users-add_to_groups">users.add_to_groups</a> </td><td class="col1"> Добавляет пользователя в группы. </td>
</tr>
<tr class="row6">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/users-remove_from_groups" class="wikilink1" title="manual:components:api:methods:users-remove_from_groups" data-wiki-id="manual:components:api:methods:users-remove_from_groups">users.remove_from_groups</a> </td><td class="col1"> Убирает пользователя из групп. </td>
</tr>
</table></div>
<!-- EDIT{"target":"table","name":"","hid":"table2","secid":7,"range":"3390-4206"} -->
</div>
<!-- EDIT{"target":"section","name":"\u041f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u0438","hid":"\u043f\u043e\u043b\u044c\u0437\u043e\u0432\u0430\u0442\u0435\u043b\u0438","codeblockOffset":0,"secid":6,"range":"3352-4207"} -->
<h2 class="sectionedit8" id="стена">Стена</h2>
<div class="level2">
<div class="table sectionedit9"><table class="inline">
<thead>
<tr class="row0">
<th class="col0"> Название </th><th class="col1"> Описание </th>
</tr>
</thead>
<tr class="row1">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/wall-get" class="wikilink2" title="manual:components:api:methods:wall-get" rel="nofollow" data-wiki-id="manual:components:api:methods:wall-get">wall.get</a> </td><td class="col1"> Возвращает список записей со стены пользователя или группы. </td>
</tr>
</table></div>
<!-- EDIT{"target":"table","name":"","hid":"table3","secid":9,"range":"4232-4440"} -->
</div>
<!-- EDIT{"target":"section","name":"\u0421\u0442\u0435\u043d\u0430","hid":"\u0441\u0442\u0435\u043d\u0430","codeblockOffset":0,"secid":8,"range":"4208-4441"} -->
<h2 class="sectionedit10" id="комментарии">Комментарии</h2>
<div class="level2">
<div class="table sectionedit11"><table class="inline">
<thead>
<tr class="row0">
<th class="col0"> Название </th><th class="col1"> Описание </th>
</tr>
</thead>
<tr class="row1">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/comments-get" class="wikilink2" title="manual:components:api:methods:comments-get" rel="nofollow" data-wiki-id="manual:components:api:methods:comments-get">comments.get</a> </td><td class="col1"> Получает комментарии. </td>
</tr>
</table></div>
<!-- EDIT{"target":"table","name":"","hid":"table4","secid":11,"range":"4478-4624"} -->
</div>
<!-- EDIT{"target":"section","name":"\u041a\u043e\u043c\u043c\u0435\u043d\u0442\u0430\u0440\u0438\u0438","hid":"\u043a\u043e\u043c\u043c\u0435\u043d\u0442\u0430\u0440\u0438\u0438","codeblockOffset":0,"secid":10,"range":"4442-4625"} -->
<h2 class="sectionedit12" id="личные-сообщения">Личные сообщения</h2>
<div class="level2">
<div class="table sectionedit13"><table class="inline">
<thead>
<tr class="row0">
<th class="col0"> Название </th><th class="col1"> Описание </th>
</tr>
</thead>
<tr class="row1">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/messages-send" class="wikilink1" title="manual:components:api:methods:messages-send" data-wiki-id="manual:components:api:methods:messages-send">messages.send</a> </td><td class="col1"> Отправляет сообщение. </td>
</tr>
<tr class="row2">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/messages-delete-contact" class="wikilink2" title="manual:components:api:methods:messages-delete-contact" rel="nofollow" data-wiki-id="manual:components:api:methods:messages-delete-contact">messages.delete_contact</a> </td><td class="col1"> Удаляет контакт. </td>
</tr>
<tr class="row3">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/messages-delete-mesages" class="wikilink2" title="manual:components:api:methods:messages-delete-mesages" rel="nofollow" data-wiki-id="manual:components:api:methods:messages-delete-mesages">messages.delete_mesages</a> </td><td class="col1"> Удаляет сообщения. </td>
</tr>
<tr class="row4">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/messages-delete-notice" class="wikilink2" title="manual:components:api:methods:messages-delete-notice" rel="nofollow" data-wiki-id="manual:components:api:methods:messages-delete-notice">messages.delete_notice</a> </td><td class="col1"> Удаляет уведомления. </td>
</tr>
<tr class="row5">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/messages-forgive" class="wikilink2" title="manual:components:api:methods:messages-forgive" rel="nofollow" data-wiki-id="manual:components:api:methods:messages-forgive">messages.forgive</a> </td><td class="col1"> Прекращает игнорирование контакта. </td>
</tr>
<tr class="row6">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/messages-ignore" class="wikilink2" title="manual:components:api:methods:messages-ignore" rel="nofollow" data-wiki-id="manual:components:api:methods:messages-ignore">messages.ignore</a> </td><td class="col1"> Включает игнорирование контакта. </td>
</tr>
<tr class="row7">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/messages-get" class="wikilink2" title="manual:components:api:methods:messages-get" rel="nofollow" data-wiki-id="manual:components:api:methods:messages-get">messages.get</a> </td><td class="col1"> Возвращает список сообщений. </td>
</tr>
<tr class="row8">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/messages-get-notices" class="wikilink2" title="manual:components:api:methods:messages-get-notices" rel="nofollow" data-wiki-id="manual:components:api:methods:messages-get-notices">messages.get_notices</a> </td><td class="col1"> Возвращает список уведомлений. </td>
</tr>
<tr class="row9">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/messages-readed" class="wikilink2" title="manual:components:api:methods:messages-readed" rel="nofollow" data-wiki-id="manual:components:api:methods:messages-readed">messages.readed</a> </td><td class="col1"> Помечает сообщения как прочитанные. </td>
</tr>
<tr class="row10">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/messages-restore-mesage" class="wikilink2" title="manual:components:api:methods:messages-restore-mesage" rel="nofollow" data-wiki-id="manual:components:api:methods:messages-restore-mesage">messages.restore_mesage</a> </td><td class="col1"> Восстанавливает сообщение. </td>
</tr>
</table></div>
<!-- EDIT{"target":"table","name":"","hid":"table5","secid":13,"range":"4671-5998"} -->
</div>
<!-- EDIT{"target":"section","name":"\u041b\u0438\u0447\u043d\u044b\u0435 \u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u044f","hid":"\u043b\u0438\u0447\u043d\u044b\u0435-\u0441\u043e\u043e\u0431\u0449\u0435\u043d\u0438\u044f","codeblockOffset":0,"secid":12,"range":"4626-5999"} -->
<h2 class="sectionedit14" id="местоположение">Местоположение</h2>
<div class="level2">
<div class="table sectionedit15"><table class="inline">
<thead>
<tr class="row0">
<th class="col0"> Название </th><th class="col1"> Описание </th>
</tr>
</thead>
<tr class="row1">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/geo_get" class="wikilink1" title="manual:components:api:methods:geo_get" data-wiki-id="manual:components:api:methods:geo_get">geo.get</a> </td><td class="col1"> Возвращает список стран/регионов/городов. </td>
</tr>
<tr class="row2">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/geo_get_current_country" class="wikilink1" title="manual:components:api:methods:geo_get_current_country" data-wiki-id="manual:components:api:methods:geo_get_current_country">geo.get_current_country</a> </td><td class="col1"> Возвращает данные по текущей стране пользователя, если она была определена по его ip адресу. </td>
</tr>
</table></div>
<!-- EDIT{"target":"table","name":"","hid":"table6","secid":15,"range":"6042-6471"} -->
</div>
<!-- EDIT{"target":"section","name":"\u041c\u0435\u0441\u0442\u043e\u043f\u043e\u043b\u043e\u0436\u0435\u043d\u0438\u0435","hid":"\u043c\u0435\u0441\u0442\u043e\u043f\u043e\u043b\u043e\u0436\u0435\u043d\u0438\u0435","codeblockOffset":0,"secid":14,"range":"6000-6472"} -->
<h2 class="sectionedit16" id="загрузка-изображений">Загрузка изображений</h2>
<div class="level2">
<div class="table sectionedit17"><table class="inline">
<thead>
<tr class="row0">
<th class="col0"> Название </th><th class="col1"> Описание </th>
</tr>
</thead>
<tr class="row1">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/images_get_presets" class="wikilink1" title="manual:components:api:methods:images_get_presets" data-wiki-id="manual:components:api:methods:images_get_presets">images.get_presets</a> </td><td class="col1"> Возвращает список всех доступных <a href="https://docs.instantcms.ru/manual/components/images" class="wikilink1" title="manual:components:images" data-wiki-id="manual:components:images">пресетов</a>. </td>
</tr>
<tr class="row2">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/images_upload" class="wikilink1" title="manual:components:api:methods:images_upload" data-wiki-id="manual:components:api:methods:images_upload">images.upload</a> </td><td class="col1"> Загружает изображение. </td>
</tr>
</table></div>
<!-- EDIT{"target":"table","name":"","hid":"table7","secid":17,"range":"6526-6863"} -->
</div>
<!-- EDIT{"target":"section","name":"\u0417\u0430\u0433\u0440\u0443\u0437\u043a\u0430 \u0438\u0437\u043e\u0431\u0440\u0430\u0436\u0435\u043d\u0438\u0439","hid":"\u0437\u0430\u0433\u0440\u0443\u0437\u043a\u0430-\u0438\u0437\u043e\u0431\u0440\u0430\u0436\u0435\u043d\u0438\u0439","codeblockOffset":0,"secid":16,"range":"6473-6864"} -->
<h2 class="sectionedit18" id="общие-методы">Общие методы</h2>
<div class="level2">
<div class="table sectionedit19"><table class="inline">
<thead>
<tr class="row0">
<th class="col0"> Название </th><th class="col1"> Описание </th>
</tr>
</thead>
<tr class="row1">
<td class="col0"> <a href="https://docs.instantcms.ru/manual/components/api/methods/execute" class="wikilink1" title="manual:components:api:methods:execute" data-wiki-id="manual:components:api:methods:execute">execute</a> </td><td class="col1"> Универсальный метод, который позволяет запускать последовательность других методов, сохраняя промежуточные результаты и возвращая их все в одном ответе. </td>
</tr>
</table></div>
<!-- EDIT{"target":"table","name":"","hid":"table8","secid":19,"range":"6902-7282"} --><hr />
<p>
Назад к описанию компонента <a href="https://docs.instantcms.ru/manual/components/api" class="wikilink1" title="manual:components:api" data-wiki-id="manual:components:api">InstantCMS JSON API</a>
</p>
</div>
<!-- EDIT{"target":"section","name":"\u041e\u0431\u0449\u0438\u0435 \u043c\u0435\u0442\u043e\u0434\u044b","hid":"\u043e\u0431\u0449\u0438\u0435-\u043c\u0435\u0442\u043e\u0434\u044b","codeblockOffset":0,"secid":18,"range":"6865-"} -->