Перейти к основному содержимому
Версия: 1.14.2

Другое

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

Запрос me позволяет получить информацию об авторизованном пользователе.

me: UserType!

UserType!: Результат запроса - список ссылок:

  • username: String!: Логин.
  • email: String!: Почта пользователя.
  • firstName: String!: Имя пользователя.
  • lastName: String!: Фамилия пользователя.
  • workspaces: [WorkspaceType!]!: Информация о воркспейсах пользователя.

Пример запроса:

{
me {
email
firstName
lastName
username
workspaces {
id
}
}
}

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

API возвращает следующий результат:
{
"data": {
"me": {
"email": "aa@aa.ru",
"firstName": "",
"lastName": "",
"username": "aa@aa.ru",
"workspaces": [
{
"id": "8d100a02-1b5b-4da1-b645-9fd01ef09c77"
}
]
}
}
}

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

Запрос workspaceInfo позволяет получить информацию о воркспейсе пользователя.

query {
workspaceInfo { }}

Выходные параметры:

  • id
    • Идентификатор воркспейса
    • Тип данных: ID
  • title
    • Название воркспейса
    • Тип данных: String.
  • config
    • Конфигурационные данные воркспейса
    • Формат данных: JSON.
  • agentsCount
    • Количество агентов в воркспейсе
    • Тип данных: Int.
  • activeAgentsCount
    • Количество активных агентов в воркспейсе
    • Тип данных: Int.
  • activeDevicesCount
    • Количество активных агентов в воркспейсе
    • Тип данных: Int.
  • profilesCount
    • Количество профилей в воркспейсе
    • Тип данных: Int.
  • profileGroupsCount
    • Количество групп в воркспейсе
    • Тип данных: Int.
  • active
    • Статус воркспейса
    • Тип данных: Boolean.
  • planName
    • Имя платежного плана
    • Тип данных: String.
  • checkoutUpgrade
    • URL для обновления платежного плана воркспейса
    • Тип данных: String.
  • detailCard
    • URL с реквизитами платежного плана воркспейса
    • Тип данных: String.

Пример запроса:

query {
workspaceInfo {
id
title
config
agentsCount
activeAgentsCount
activeDevicesCount
profilesCount
profileGroupsCount
active
planName
checkoutUpgrade
detailCard
}
}

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

API возвращает следующий результат:
{
"data": {
"workspaceInfo": {
"id": "***",
"title": "***",
"config": {
"features": {
"retail_analytics": {
"enabled": true
}
},
"is_active": true,
"sample_ttl": ***,
"activity_ttl": ***,
"template_version": "***",
"activity_score_threshold": 0.85,
"notification_score_threshold": 0.85
},
"agentsCount": 0,
"activeAgentsCount": 0,
"activeDevicesCount": 0,
"profilesCount": 0,
"profileGroupsCount": 1,
"active": true,
"planName": "",
"checkoutUpgrade": "***",
"detailCard": "***"
}
}
}

Получить информацию о платформе

Запрос platformInformation позволяет получить информацию об установленной платформе.

query {
platformInformation { }}

Выходные параметры:

  • platformVersion
    • Версия платформы
    • Тип данных: String.
  • templateVersion
    • Версия создаваемого биометрического шаблона
    • Тип данных: String.
  • sampleTtl
    • Время хранения сэмплов в базе данных (в секундах)
    • Тип данных: String.
  • activityTtl
    • Время хранения активностей в базе данных (в секундах)
    • Тип данных: String.
  • osVersion
    • Версия операционной системы
    • Тип данных: String.

Пример запроса:

query {
platformInformation {
platformVersion
templateVersion
sampleTtl
activityTtl
osVersion
}
}

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

API возвращает следующий результат:
{
"data": {
"platformInformation": {
"platformVersion": "***",
"templateVersion": "***",
"sampleTtl": "***",
"activityTtl": "***",
"osVersion": "***"
}
}
}

Обновить файл конфигурации воркспейса

Мутация updateWorkspaceConfig позволяет обновить файл конфигурации воркспейса.

mutation {
updateWorkspaceConfig() { }}

Выходные параметры:

  • workspaceConfig:
    • activityScoreThreshold
      • Порог привязки активности к профилю. Если значение Score из процессов агента (лучший результат сравнения лица с камеры с лицом из профиля) равен или выше порогового значения Score, активность привязывается к профилю.
      • Тип данных: Float.
    • notificationScoreThreshold
      • Порог создания оповещений для профиля. Если значение Score из процессов агента (лучший результат сравнения лица с камеры с лицом из профиля) равен или выше порогового значения Score, активность привязывается к профилю, и создается оповещение об активности профиля.
      • Тип данных: Float.

Выходные параметры:

  • ok
    • Статус завершения мутации
    • Тип данных: Boolean
  • workspaces: (Информация о воркспейсе пользователя)
    • id
      • Идентификатор воркспейса
      • Тип данных: ID
    • title
      • Название воркспейса
      • Тип данных: String.
    • config
      • Конфигурационные данные воркспейса
      • Формат данных: JSON.
    • accesses (Информация о доступе к воркспейсам)
      • id
        • Идентификатор
        • Тип данных: ID
      • token
        • Токен доступа
        • Тип данных: ID
      • workspaceIsActive
        • Статус воркспейса
        • Тип данных: Boolean
      • workspaceTitle
        • Название воркспейса
        • Тип данных: String
      • username
        • Логин
        • Тип данных: String.
    • agentsCount
      • Количество агентов в воркспейсе
      • Тип данных: Int.
    • activeAgentsCount
      • Количество активных агентов в воркспейсе
      • Тип данных: Int.
    • activeDevicesCount
      • Количество активных агентов в воркспейсе
      • Тип данных: Int.
    • profilesCount
      • Количество профилей в воркспейсе
      • Тип данных: Int.
    • profileGroupsCount
      • Количество групп в воркспейсе
      • Тип данных: Int.
    • active
      • Статус воркспейса
      • Тип данных: Boolean.
    • planName
      • Название платежного плана
      • Тип данных: String.
    • checkoutUpgrade
      • URL для обновления платежного плана воркспейса
      • Тип данных: String.
    • detailCard
      • URL для смены платежных данных
      • Тип данных: String.

Пример запроса:

mutation {
updateWorkspaceConfig(workspaceConfig: {activityScoreThreshold: 0.90 notificationScoreThreshold: 0.90})
{
ok
workspace {
config
}
}
}

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

API возвращает следующий результат:
{
"data": {
"updateWorkspaceConfig": {
"ok": true,
"workspace": {
"config": {
"features": {
"retail_analytics": {
"enabled": true
}
},
"is_active": true,
"sample_ttl": 2592000,
"activity_ttl": 2592000,
"template_version": "template12v100",
"activity_score_threshold": 0.9,
"notification_score_threshold": 0.9
}
}
}
}
}