update
Этот метод используется для управления вашими токенами и токенами пользователей, к которым у вас есть доступ. Этот метод не используется для аутентификации. Для входа в систему используйте token/login.
Для создания, редактирования или удаления токена используйте метод token/update:
svc=token/update¶ms={"callMode":<text>,
"userId":<text>,
"h":<text>,
"app":<text>,
"at":<uint>,
"dur":<uint>,
"fl":<uint>,
"p":<text>,
"items":[<long>],
"deleteAll":<bool>|<text>
}
Параметры
Запрос может содержать следующие параметры. Обязательные параметры отмечены звездочкой (*).
| Имя | Описание |
|---|---|
| callMode* | Действие, которое вы хотите выполнить. Для создания токена укажите create в этом параметре. Для редактирования токена передайте в параметре update, а для удаления - delete. |
| userId | ID нижестоящего пользователя. Параметр используется для управления ключами других пользователей. |
| h* | Имя ключа. Состоит из 72 символов. Этот параметр должен использоваться в запросах на редактирование и удаление ключа. |
| app* | Название приложения. |
| at* | Время активации ключа, UNIX-time. Вы можете передать 0 в этом параметре, чтобы ключ активировался сразу после успешного выполнения запроса. |
| dur* | Длительность действия ключа после активации, секунды. Передайте 0 в этом параметре для установки бесконечной длительности. |
| fl* | Флаги доступа. |
| p* | Пользовательские параметры, значение должно быть объектом или массивом объектов. |
| items | Список идентификаторов элементов, к которым предоставляет доступ ключ. |
| deleteAll | Актуально для callMode:delete Передайте 1 или true для удаления всех созданных ключей. |
Токены удаляются автоматически после 100 дней бездействия (даже с dur:0).
Пример объекта для параметра p:
"p":"{\"paramA\":\"valueB\"}"
Пример массива объектов для параметра p:
"p":"[{\"paramA\":\"valueB\"},{\"paramB\":\"valueD\"}]"
Флаги доступа
| Значение | Описание |
|---|---|
| 0x100 | Слежение за объектами в реальном времени. |
| 0x200 | Доступ к просмотру большинства данных. |
| 0x400 | Изменение нечувствительных данных. |
| 0x800 | Изменение особо важных данных. |
| 0x1000 | Изменение особо важных данных, включая удаление сообщений. |
| 0x2000 | Связь с объектом (отправка команд). |
| 0xFFFFFFFF | Неограниченная работа в качестве авторизованного пользователя (позволяет управлять токенами пользователя). |
Смотрите дополнительную информацию о флагах токенов на странице Токены.
Ответ
В случае успешного выполнения запроса возвращается ответ следующего формата:
{
"h":<text>, /* Уникальное имя токена, 72 символа. */
"app":<text>, /* Название приложения. */
"at":<uint>, /* Время активации токена, UNIX-time. */
"ct":<uint>, /* Время создания токена, UNIX-time. */
"dur":<uint>, /* Длительность действия токена после активации, секунды. */
"fl":<uint>, /* Флаги доступа. */
"items":[<long>], /* Список идентификаторов элементов, к которым предоставляет доступ токен. */
"p":<text> /* Произвольные параметры. Значение должно быть объектом или массивом объектов. */
}
В случае неудачного выполнения запроса возвращается код ошибки.
Коды ошибок
| Код ошибки | Описание |
|---|---|
| 4 | Неверные входные параметры. |
| 1003 | Достигнут лимит запросов. |
| 7 | Одна из следующих ошибок: |