Метод работы с мобильными устройствами

Для работы с мобильными устройствами выполните запросы с помощью API-метода devices (перед выполнением запроса определите токен администратора):

добавление мобильного устройства:

curl -X POST -v '<IP-адрес или DNS-имя сервера>/api/v2/devices/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>' -d '{
    "id_string": "<идентификатор устройства>",
    "is_active": <признак активности устройства (true/false)>,
    "os_version": "<версия ОС устройства (ANDROID, IOS, UWP, OTHER)>"
}'

Пример ответа:

{
    "id": 5,
    "id_string": "device4",
    "is_active": true,
    "registration_date": "2022-06-06T10:58:03.516823+03:00",
    "last_enter": null,
    "os_version": "IOS"
}

получение списка мобильных устройств:

curl -X GET '<IP-адрес или DNS-имя сервера>/api/v2/devices/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>'

Пример ответа:

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [{
        "id": 1,
        "id_string": "new_device",
        "is_active": true,
        "registration_date": "2023-12-13T18:52:48.792770+04:00",
        "last_enter": "2024-01-24T13:34:26.927070+04:00",
        "active_users_count": 1,
        "os_version": "OTHER"
   },{
        "id": 2,
        "id_string": "11",
        "is_active": true,
        "registration_date": "2024-01-16T11:26:47.227645+04:00",
        "last_enter": "2024-01-16T11:26:47.262803+04:00",
        "active_users_count": 0,
        "os_version": "OTHER"
    }]
}

Значения параметров содержат следующую информацию о каждом мобильном устройстве:

id. Идентификатор мобильного устройства;
id_string. Идентификатор мобильного устройства в консоли администратора;
is_active. Признак активности устройства;
registration_date. Дата регистрации мобильного устройства;
last_enter. Дата последней аутентификации пользователя через мобильное устройство;
active_users_count. Количество активных, привязанных пользователей API;
os_version. Версия ОС мобильного устройства.

получение информации о конкретном мобильном устройстве:

curl -v '<IP-адрес или DNS-имя сервера>/api/v2/devices/<идентификатор запрашиваемого устройства>/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>'

В подстановке <идентификатор запрашиваемого устройства> используйте значение параметра id, которое возвращается при получении списка мобильных устройств.

Пример ответа:

{
    "id": 3,
    "id_string": "device2",
    "is_active": true,
    "registration_date": "2022-06-06T10:29:49.320247+03:00",
    "last_enter": null,
    "active_users_count": 0,
    "os_version": "UWP"
}

изменение параметров конкретного мобильного устройства:

curl -X PUT -v '<IP-адрес или DNS-имя сервера>/api/v2/devices/<идентификатор запрашиваемого устройства>/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>' -d '{
    "id_string": "<идентификатор устройства>",
    "is_active": <признак активности устройства (true/false)>,
    "os_version": "<версия ОС устройства (ANDROID, IOS, UWP, OTHER)>"
}'

Пример ответа:

{
    "id": 3,
    "id_string": "new_name",
    "is_active": false,
    "registration_date": "2022-06-06T10:29:49.320247+03:00",
    "last_enter": null,
    "active_users_count": 0,
    "os_version": "ANDROID"
}

получение списка пользователей API, связанных с конкретным мобильным устройством:

curl -v '<IP-адрес или DNS-имя сервера>/api/v2/devices/<идентификатор запрашиваемого устройства>/api-users/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>'

Пример ответа:

{
    "results": [
        {
            "id": 6,
            "environment_name": "environment",
            "project_name": "project",
            "username": "user11",
            "devices_count": 1,
            "is_active": true
        },
        {
            "id": 7,
            "environment_name": "environment",
            "project_name": "project",
            "username": "user22",
            "devices_count": 1,
            "is_active": true
        }
    ]
}

удаление связи между пользователем API и мобильным устройством:

curl -X DELETE '<IP-адрес или DNS-имя сервера>/api/v2/devices/<идентификатор запрашиваемого устройства>/api-users/<идентификатор пользователя>/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>'

В подстановке <идентификатор запрашиваемого устройства> используйте значение параметра id, которое возвращается при получении списка мобильных устройств, а в подстановке <идентификатор пользователя> - значение параметра username, которое возвращается при получении списка пользователей API.

Пример ответа:

204 No Content

удаление мобильного устройства:

curl -X DELETE -v '<IP-адрес или DNS-имя сервера>/api/v2/devices/<идентификатор запрашиваемого устройства>/' --header 'Content-Type: application/json' -H 'Authorization: Bearer <токен администратора>'

Пример ответа:

204

См. также:

API сервера