VRt.Account [AC] (7.10.2580)

Veeroute Support Team: servicedesk@veeroute.com License: Proprietary Terms of Service

Сайт компании Veeroute

Описание

Программный интерфейс для управления учетной записью Veeroute.

Диаграмма сущностей

erd

Auth

Авторизация.

Получение токена

Получение токена по паре логин - пароль.

Request Body schema: application/json
required

Запрос на получение токена.

username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
password required	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Пароль.
ttl_seconds	integer <int32> [ 60 .. 31556926 ] Default: 86400 Example: "86400" Время действия токена, в секундах.

Responses

Response Schema: application/json

string (token) [ 10 .. 1000 ] characters

Токен (JWT).

Request samples

Payload

Content type

application/json

{"username": "username_for_login",
"password": "long_strong_password",
"ttl_seconds": 86400
}

Response samples

Content type

application/json

"new.jwt.token"

Проверка токена

Проверка токена.

Request Body schema: application/json
required

Запрос на проверку токена.

string (token) [ 10 .. 1000 ] characters

Токен (JWT).

Responses

Response Schema: application/json

valid required	boolean Example: "true" Статус токена.
roles required	Array of strings (user_role_list) [ 0 .. 2 ] items unique Items Enum: "ADMIN" "PARTNER" "USER" … 1 more Example: "USER" Перечень ролей пользователя.

Request samples

Payload

Content type

application/json

"new.jwt.token"

Response samples

Content type

application/json

{"valid": true,
"roles": ["USER"
]
}

Смена пароля

Смена пароля на новый и получение нового токена.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
optional

Данные для смены пароля.

current_password required	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Пароль.
new_password required	string or null <password> (user_password) [ 10 .. 256 ] characters Example: "long_strong_password" Пароль.

Responses

Response Schema: application/json

string (token) [ 10 .. 1000 ] characters

Токен (JWT).

Request samples

Payload

Content type

application/json

{"current_password": "long_strong_password",
"new_password": "long_strong_password"
}

Response samples

Content type

application/json

"new.jwt.token"

Info

Информация об аккаунте.

Информация об аккаунте

Получение информации об аккаунте.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
specification	string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" Описание пользователя.
email	string or null <email> (user_email) [ 5 .. 256 ] characters Example: "admin@company.com" Почта пользователя.
phone	string or null (user_phone) [ 5 .. 32 ] characters Example: "+71112223333" Телефон пользователя.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
enabled	boolean Default: true Example: "true" Статус пользователя.
roles required	Array of strings (user_role_list) [ 0 .. 2 ] items unique Items Enum: "ADMIN" "PARTNER" "USER" … 1 more Example: "USER" Перечень ролей пользователя.
timezone	integer <int32> (timezone) [ -12 .. 12 ] Example: "3" Базовая временная зона, которая используется для расчета статистики.
edit_date	string or null <date-time> Default: null Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date	string or null <date-time> Default: null Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Атрибуты. Используются для указания служебной информации.

Response samples

Content type

application/json

{"username": "username_for_login",
"specification": "User full name",
"email": "admin@company.com",
"phone": "+71112223333",
"company_key": "smart_company",
"enabled": true,
"roles": ["USER"
],
"timezone": 3,
"edit_date": "2024-11-21T19:45:00Z",
"creation_date": "2024-11-21T19:45:00Z",
"attributes": [ ]
}

Обновление информации об аккаунте

Обновление информации о аккаунте.

Authorizations:

ApiKeyAuth

Request Body schema: application/json
required

Запрос на обновление информации о аккаунте.

specification	string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" Описание пользователя.
email	string or null <email> (user_email) [ 5 .. 256 ] characters Example: "admin@company.com" Почта пользователя.
phone	string or null (user_phone) [ 5 .. 32 ] characters Example: "+71112223333" Телефон пользователя.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Атрибуты. Используются для указания служебной информации.

Responses

Response Schema: application/json

username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
specification	string or null (user_specification) [ 2 .. 256 ] characters Example: "User full name" Описание пользователя.
email	string or null <email> (user_email) [ 5 .. 256 ] characters Example: "admin@company.com" Почта пользователя.
phone	string or null (user_phone) [ 5 .. 32 ] characters Example: "+71112223333" Телефон пользователя.
company_key required	string (company_key) [ 3 .. 256 ] characters \w+ Example: "smart_company" Уникальный идентификатор компании.
enabled	boolean Default: true Example: "true" Статус пользователя.
roles required	Array of strings (user_role_list) [ 0 .. 2 ] items unique Items Enum: "ADMIN" "PARTNER" "USER" … 1 more Example: "USER" Перечень ролей пользователя.
timezone	integer <int32> (timezone) [ -12 .. 12 ] Example: "3" Базовая временная зона, которая используется для расчета статистики.
edit_date	string or null <date-time> Default: null Example: "2024-11-21T19:45:00Z" Дата и время последнего редактирования в соответствии с ISO 8601.
creation_date	string or null <date-time> Default: null Example: "2024-11-21T19:45:00Z" Дата и время создания в соответствии с ISO 8601.
	Array of objects (attributes) [ 0 .. 1000 ] items unique Атрибуты. Используются для указания служебной информации.

Request samples

Payload

Content type

application/json

{"specification": "User full name",
"email": "admin@company.com",
"phone": "+71112223333",
"attributes": [ ]
}

Response samples

Content type

application/json

{"username": "username_for_login",
"specification": "User full name",
"email": "admin@company.com",
"phone": "+71112223333",
"company_key": "smart_company",
"enabled": true,
"roles": ["USER"
],
"timezone": 3,
"edit_date": "2024-11-21T19:45:00Z",
"creation_date": "2024-11-21T19:45:00Z",
"attributes": [ ]
}

Statistics

Статистика.

Статистика за период

Статистика за период. Если период не указывается - возвращается статистика за текущий месяц - с начала месяца по текущий день (не включая его). Если дата с не указана - берется начало текущего месяца. Если дата по не указана - берется вчерашний день (не включая его). Пустые поля сервиса и типа процесса означают возвращать статистику по всем сервисами и типам процесса.

Authorizations:

ApiKeyAuth

query Parameters

from	string <date> Example: from=2024-11-22 Дата `от` в формате YYYY-MM-DD.
to	string <date> Example: to=2024-11-26 Дата `до` (включительно) в формате YYYY-MM-DD.
service	string (service) Enum: "UNIVERSAL" "ROUTING" "ACCOUNT" … 5 more Example: service=UNIVERSAL Название сервиса.
process_type	string (process_type) Enum: "NOTRACE" "TRACE" "PLAN" … 4 more Example: process_type=PLAN Тип процесса.

Responses

Response Schema: application/json

username required	string (user_username) [ 2 .. 256 ] characters \w+ Example: "username_for_login" Уникальное имя пользователя для авторизации.
required	Array of objects (date_statistics) [ 0 .. 3653 ] items Список статистик по каждому дню для указанного пользователя.

Response samples

Content type

application/json

{"username": "username_for_login",
"dates": [{"date": "2024-11-05",
"services": [{"service": "UNIVERSAL",
"processes": [{"process_type": "PLAN",
"unique_points_per_day": 1500,
"points_per_day": 2500,
"elements_per_day": 2500,
"processes_per_day": 776
}
]
}
]
}
]
}

Создание отчета

Создание отчета со статистикой по использованию. Если дата не указана - возвращается статистика за текущий месяц - с начала месяца по текущий день (не включая его). Если дата с не указана - берется начало текущего месяца. Если дата по не указана - берется текущий день (не включая его). Пустые поля сервиса и типа процесса означают возвращать статистику по всем сервисами и типам процесса.

Authorizations:

ApiKeyAuth

query Parameters

from	string <date> Example: from=2024-11-22 Дата `от` в формате YYYY-MM-DD.
to	string <date> Example: to=2024-11-26 Дата `до` (включительно) в формате YYYY-MM-DD.
service	string (service) Enum: "UNIVERSAL" "ROUTING" "ACCOUNT" … 5 more Example: service=UNIVERSAL Название сервиса.
process_type	string (process_type) Enum: "NOTRACE" "TRACE" "PLAN" … 4 more Example: process_type=PLAN Тип процесса.

Responses

Response Schema: application/octet-stream

string <byte> (file_xlsx)

Файл с данными в формате XLSX.

Response samples

400
402
403
429
500

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
},
"message": "Bad Request"
}

Audit

Пользовательские действия.

Действия за период

Действия пользователей за период. Если период не указывается - возвращаются данные за текущий день - с начала дня по текущее время включительно. Если не указано начало временного отрезка - возвращаются данные с начала текущего дня. Если не указан конец временного отрезка - возвращаются данные до текущего времени.

Authorizations:

ApiKeyAuth

query Parameters

offset	integer <int32> [ 0 .. 10000000 ] Default: 0 Example: offset=10 Количество пропущенных сущностей до возвращаемого списка.
limit	integer <int32> [ 1 .. 10000000 ] Default: 100 Example: limit=10 Максимальное количество возвращаемых сущностей.
from	string <date-time> Example: from=2024-11-21T09:30:00+03:00 Дата и время в соответствии с ISO 8601, начиная с которого (включительно) будет производится выгрузка данных. Если не указано - возвращаются данные с начала текущего дня.
to	string <date-time> Example: to=2024-11-21T18:00:00+03:00 Дата и время в соответствии с ISO 8601, до которого (включительно) будет производится выгрузка данных. Если не указано - возвращаются данные до текущего времени.
service	string (service) Enum: "UNIVERSAL" "ROUTING" "ACCOUNT" … 5 more Example: service=UNIVERSAL Название сервиса.
operation	string (operation) [ 3 .. 256 ] characters \w+ Example: operation=run_plan_calculation Название операции.
process_type	string (process_type) Enum: "NOTRACE" "TRACE" "PLAN" … 4 more Example: process_type=PLAN Тип процесса.
status	string (calculation_status) Enum: "WAITING" "IN_PROGRESS" "FINISHED_IN_TIME" … 5 more Example: status=FINISHED_IN_TIME Статус процесса.
sort_field	string [ 1 .. 64 ] characters Example: sort_field=name Поле, по которому необходимо делать сортировку.
sort_direction	string Default: "ASC" Enum: "ASC" "DESC" Example: sort_direction=DESC Направление сортировки.

Responses

Response Schema: application/json

required	Array of objects (audit_action) [ 0 .. 10000000 ] items Список пользовательских действий.
required	object (audit_counters) Счетчики по списку записей.

Response samples

Content type

application/json

{"actions": [{"process_code": "11111111-2222-3333-4444-555555555555",
"process_type": "PLAN",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"time": "2024-11-21T09:30:00+03:00",
"requests": [{"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
}
],
"statistics": {"request_points_count": 1500,
"result_elements_count": 500,
"calculation_info": {"status": "FINISHED_IN_TIME",
"result_version": 133,
"preparing_time": "PT1H45M",
"business_validation_time": "PT1H45M",
"math_validation_time": "PT1H45M",
"waiting_time": "PT1H45M",
"calculation_time": "PT1H45M"
}
},
"input_file_exists": true,
"output_file_exists": true
}
],
"counters": {"overall": {"total": 1
},
"filter": {"total": 1
}
}
}

Data

Пользовательские данные.

Чтение данных

Получение данных по tracedata.process_code.

Authorizations:

ApiKeyAuth

path Parameters

process_code

required

string <uuid> (process_code)

Example: 11111111-2222-3333-4444-555555555555

Уникальный идентификатор процесса.

query Parameters

data_flow_type	string (flow_type) Default: "INPUT" Enum: "INPUT" "OUTPUT" Example: data_flow_type=OUTPUT Тип потока обработки данных.
data_flow_stage	string Default: "RAW" Value: "RAW" Example: data_flow_stage=RAW Этап потока обработки данных.

Responses

Response Schema: application/octet-stream

string <byte> (file_binary)

Файл с данными (octet-stream).

Response samples

Content type

application/json

{"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
},
"message": "Bad Request"
}

Quota

Квотирование.

Чтение списка квот

Чтение списка квот по пользователю.

Authorizations:

ApiKeyAuth

Responses

Response Schema: application/json

required

object (quota_base)

Квота на все сервисы.

Response samples

Content type

application/json

{"base": {"services": [{"service": "UNIVERSAL",
"processes": [{"process_type": "PLAN",
"points_per_request": 1500,
"points_per_day": 25000,
"max_concurrent_execution": 5
}
]
}
]
}
}

System

Системные функции. Вспомогательный функционал, общий для всех сервисов.

Проверка доступности

Проверка доступности сервиса.

Responses

Response Schema: application/json

health

required

number <double> [ 0 .. 1 ]

Example: "0.999"

Текущий показатель здоровья сервиса.

0.0 означает неготовность сервиса выполнять задачи.
1.0 означает полную готовность сервиса для выполнения задач.

Response samples

200
404
429
500

Content type

application/json

{"health": 0.999
}

Получение версии сервиса

Получение версии сервиса.

Responses

Response Schema: application/json

major required	integer <int32> [ 1 .. 100 ] Example: "7" Версия продукта. В рамках одной версии гарантируется совместимость общих структур данных между сервисами. Изменение версии указывает на несовместимые с предыдущими версиями продукта (и, соответственно, всех сервисов) изменения.
minor required	integer <int32> [ 0 .. 111 ] Example: "15" Минорная версия сервиса. Изменение версии указывает на новую функциональность. Обновление имеет обратную совместимость в рамках мажорной версии сервиса.
build required	string [ 1 .. 64 ] characters Example: "3754RC" Версия сборки. Изменяется при обновлении документации и исправлении ошибок.

Response samples

200
404
429
500

Content type

application/json

{"major": 7,
"minor": 15,
"build": "3754RC"
}

Получение документации

Получение файла с документацией на этот сервис.

path Parameters

filename

required

string [ 6 .. 128 ] characters

Example: file_en.html

Название файла.

Responses

Response Schema:
text/html

string (file_html)

Файл с данными в формате HTML.

Response samples

404
429
500

Content type

application/json

{"resource_key": "resource_key",
"detail": {"tracedata": {"process_code": "11111111-2222-3333-4444-555555555555",
"request_code": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"username": "username_for_login",
"company": "smart_company",
"service": "UNIVERSAL",
"operation": "run_plan_calculation",
"env": "edge7",
"pod": "11111111-2222-3333-4444-555555555555",
"time": "2024-11-21T09:30:00+03:00"
}
}
}

VRt.Account [AC] (7.10.2580)

Описание

Диаграмма сущностей

Auth

Получение токена

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Проверка токена

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Смена пароля

Authorizations:

Request Body schema: application/jsonoptional

Responses

Response Schema: application/json

Request samples

Response samples

Info

Информация об аккаунте

Authorizations:

Responses

Response Schema: application/json

Response samples

Обновление информации об аккаунте

Authorizations:

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Statistics

Статистика за период

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Создание отчета

Authorizations:

query Parameters

Responses

Response Schema: application/octet-stream

Response samples

Audit

Действия за период

Authorizations:

query Parameters

Responses

Response Schema: application/json

Response samples

Data

Чтение данных

Authorizations:

path Parameters

query Parameters

Responses

Response Schema: application/octet-stream

Response samples

Quota

Чтение списка квот

Authorizations:

Responses

Response Schema: application/json

Response samples

System

Проверка доступности

Responses

Response Schema: application/json

Response samples

Получение версии сервиса

Responses

Response Schema: application/json

Response samples

Получение документации

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
optional

Request Body schema: application/json
required

Response Schema:
text/html