manual:components:api:methods:auth-signup_fields
Содержание
auth.signup_fields
Получает имена полей, обязательных для регистрации, которые потом используются в методе auth.signup.
Параметры
| Название | Описание |
|---|---|
| — | Метод не имеет параметров |
Пример
instantcms_site.ru/api/method/auth.signup_fields?api_key=API_KEY
Результат
После успешного выполнения возвращает объект item, содержащий сгруппированный массив полей для заполнения и параметр sig, содержащий 32-х символьный код, который потом нужно передать одноименным параметром в методе auth.signup. sig привязан к конкретному домену сайта и к ip адресу посетителя.
Каждый объект поля (из объекта item) состоит из ячеек:
| Название | Описание |
|---|---|
| default | Значение поля по умолчанию. |
| title | Название поля. |
| hint | Расшифровка названия поля. |
| items | Массив возможных значений. |
| name | Имя поля. Является названием параметра запроса в методе auth.signup. |
| rules | Массив возможных правил валидации поля. |
| var_type | Тип данных поля. Возможные значения: boolean, integer, double, string. |
Коды ошибок
| Код | Описание |
|---|---|
| 323 | Регистрация запрещена. |
В ходе выполнения также могут произойти общие ошибки.
Назад к описанию методов API
manual/components/api/methods/auth-signup_fields.txt · Последнее изменение: — fuze
