Пользователи

Учетные записи пользователей конфигурируются на платформе в качестве сущностей. Они так же, как и другие сущности, обладают рядом обязательных и необязательных полей, значения которых записываются в конфигурацию. Соответственно, пользователь может управлять своим аккаунтом не только через графический интерфейс платформы, но в том числе и через API посредством реализации следующих действий:

  1. Получение списка пользователей.
  2. Получение информации об одном пользователе.
  3. Создание новой учетной записи.
  4. Редактирование учетной записи.
  5. Удаление учетной записи.
  6. Издание токена для пользователя.

Получение списка пользователей

При получении списка учетных записей всех пользователей необходимо отправить запрос GET /api/v1/users. При этом в ответе будет получен список, включающий в себя только тех пользователей, которые входят в ту же группу, что и пользователь, отправивший запрос.

Запрос

GET /api/v1/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

Ответ

HTTP/1.1 200 OK

[
    {
        "_id": "5d8a18d5d0025e0012fb6a34",
        "login": "user_login",
        "name": "user_name",
        "email": "user_email",
        "rights": 1.5,
        "role": "5cc89f6af79a4969291dcbd7",
        "messages": true
    }
]

Получение информации об одном пользователе

Учетные записи пользователей так же, как и другие сущности, обладают своим идентификатором, присвоенным им системой. Соответственно, если необходимо получить данные по какому-либо определенному аккаунту, в запросе необходимо указать идентификационный номер данного аккаунта.

Запрос

GET /api/v1/users/:id HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

Ответ

HTTP/1.1 200 OK

{
    "_id": "5d8a18d5d0025e0012fb6a34",
    "login": "user_login",
    "name": "user_name",
    "email": "user_email",
    "rights": 1.5,
    "role": "5cc89f6af79a4969291dcbd7",
    "messages": true,
    "success": true
}

Создание новой учетной записи

Для создания новой учетной записи в теле запроса нужно указать все необходимые поля и присвоить им соответствующие значения.

Запрос

POST /api/v1/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

BODY

Ответ

HTTP/1.1 200 OK

BODY

Редактирование учетной записи

Для редактирования аккаунта пользователя необходимо отправить запрос PATCH /api/v1/users/:id с указанием идентификатора редактируемой сущности.

Запрос

PATCH /api/v1/users/:id HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

BODY

Ответ

HTTP/1.1 200 OK

BODY

Удаление учетной записи

Чтобы удалить учетную запись из группы, необходимо отправить запрос DELETE /api/v1/users/:id.

Запрос

DELETE /api/v1/users/:id HTTP/1.1
Content-Type: application/json
Authorization: Bearer {token}

Ответ

HTTP/1.1 200 OK

BODY

Издание токена для пользователя

Так как взаимодействие с платформой посредством использования API производится только с учетом авторизации, пользователю необходимо издать токен на те запросы, которые ему нужно отправить. Для этого существует специальный запрос POST /api/v1/users/tokens, позволяющий издавать токен для конкретного пользователя.

Запрос

POST /api/v1/users/tokens HTTP/1.1
Content-Type: application/json

Ответ

HTTP/1.1 200 OK

BODY