Протестировать методы API можно на странице интерактивного обозревателя API и без написания кода
Некоторые ресурсы, описанные на странице, по умолчанию могут быть не доступны из-за типа приложения (см. Создание и авторизация приложений)
Описание структур данных
Имя | Тип | Обяза-тельный | Описание |
|---|---|---|---|
client_id | integer | да | Идентификатор клиента, для которого создается пользователь |
access | string | нет | Тип доступа к ресурсам. Может быть 'full' или 'read_only' (нет прав на изменения) |
comment | string | нет | Комментарий (заметка) |
string | да | e-mail пользователя | |
email_notify | boolean | нет | Если параметр принимает значение ‘True’,тогда на почту будут высланы данные для доступа в систему для нового пользователя . В случае указания будут высланы на электронную почту:
|
email_for_notify | string | нет | полеПоле, необходимое для параметра email_notify, – это e-mail, куда будут отправлены данные при создании нового пользователя |
extra_params | string | нет | Поле для дополнительных параметров, можно приспособить для любых целей |
login | string | да | Логин пользователя |
name | string | да | Имя пользователя |
password | string | да | Пароль пользователя |
status | string | нет | Статус пользователя. Может быть: 'active' или 'blocked' |
timezone | string | нет | Пользовательская тайм-зона |
Ресурсы раздела “Клиент”
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
POST /client/{client_id}/user/client/ Добавить нового пользователя уровня "Клиент" Параметры URL
Параметры запроса
Параметры ответа
|
| Expand | ||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
GET /client/{client_id}/user/client/ Получить список пользователей уровня “Клиент” Параметры URL
Параметры запроса (фильтр)
Параметры ответа
|
| Expand | ||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||
PUT /client/{client_id}/user/client/{user_id} Обновить пользователя уровня “Клиент” Параметры URL
Параметры запроса
Параметры ответа
|
| Expand | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||
GET /client/{client_id}/user/client/{user_id} Запросить параметры пользователя уровня “Клиент” Параметры URL
Параметры ответа
|
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
DELETE /client/{client_id}/user/client/{user_id} Удалить пользователя уровня “Клиент” Параметры URL
|