Документация InstantCMS

для администраторов и разработчиков

Инструменты пользователя

Инструменты сайта


manual:components:api:methods:users-add

users.add

Добавляет пользователя. Функционал аналогичен добавлению пользователя в админке. Метод вызывается дважды. Первый вызов осуществляется без параметров (но, разумеется, с api_key). В нём отдаются возможные поля.

Пример первого вызова

instantcms_site.ru/api/method/users.add?api_key=API_KEY

Результат первого вызова

После успешного выполнения возвращает объект item, содержащий сгруппированный массив полей для заполнения и параметр sig, содержащий 32-х символьный код, который потом нужно передать одноименным параметром во втором запросе к этому методу. sig привязан к конкретному домену сайта и к ip адресу посетителя.

Каждый объект поля (из объекта item) состоит из ячеек:

Название Описание
default Значение поля по умолчанию.
title Название поля.
hint Расшифровка названия поля.
items Массив возможных значений.
name Имя поля. Является названием параметра запроса.
rules Массив возможных правил валидации поля.
var_type Тип данных поля. Возможные значения: boolean, integer, double, string.

Во втором вызове уже передаются параметры, описанные ниже. Обратите внимание, что во втором запросе обязательно наличие параметра submit.

Параметры второго вызова

Название Описание
sig Параметр, полученный от результата первого запроса. Параметр привязан к ip адресу клиента и к домену сайта. Это обязательный параметр.
submit Параметр, наличие которого в запросе указывает, что это второй вызов. Может принимать любое значение или быть вовсе без значения. Проверяется лишь его наличие. Это обязательный параметр.

Кроме этих параметров необходимо передать пары название поля ⇒ значение поля согласно первого запроса метода.

Пример второго запроса

instantcms_site.ru/api/method/auth.signup?api_key=API_KEY&sig=SIG&submit&email=email@site.ru&groups[]=1&nickname=Vasya&password1=123456&password2=123456

Итоговый результат

После успешного выполнения возвращает объект, содержащий данные (ответ аналогичен методу auth.signup):

Название Описание
user_id id зарегистрированного пользователя.
is_verify_email Флаг, поясняющий нужна ли верификация пользователя при помощи метода auth.confirm. В данном случае всегда будет false.
success_text Поясняющий текст после добавления пользователя.

Коды ошибок

В ходе выполнения также могут произойти общие ошибки.


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

manual/components/api/methods/users-add.txt · Последнее изменение: 06.05.2017 00:23 — fuze

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki