Получение списка приложений
Метод позволяет получить приложения, доступные владельцу аккаунта, в котором создается приватный ключ.
Параметры взаимодействия
GET
https://public-api.rustore.ru/public/v1/application
Атрибут | Тип | Обязателен | Расположение | Описание | Пример |
---|---|---|---|---|---|
Public-Token | string | Да | header | Токен доступа к Public API Rustore | |
pagination | bool | • Нет • Да, если используете continuationToken и pageSize | path | Флаг включения пагинации. По умолчанию false .Если необходимо настроить пагинацию, измените на true | |
continuationToken | string | Нет | path | Если список доступов продолжается на другой странице, API включает в ответ элемент continuationToken . Используйте значение, полученное в результате выполнения предыдущего запроса | Nzk0MjQ3Mzcw |
pageSize | string | • Нет • Да, если pagination — true | path | Количество приложений на одной странице | По умолчанию: 20 Минимум: 1 Максимум: 1000 |
appName | string | Нет | path | Параметр для поиска по appName | Name |
appPackage | string | Нет | path | Параметр для поиска по package_name | com.myapp.example |
orderFields | string | Нет | path | Параметр для сортировки | Доступные значения: • appId — id приложения• appName — наименование приложения• appStatus — статус приложения• appVerUpdatedAt — дата обновления версии |
sortDirections | string | • Нет • Да, если указан параметр orderFields | path | Возможности сортировки | Доступные значения: • ASC • DESC |
Параметры ответа
Атрибут | Тип | Обязательность | Описание | Пример |
---|---|---|---|---|
code | string | Да | Код ответа | error /OK |
message | string | Нет | Расшифровка кода ответа | |
body{} | object | Да | ||
timestamp | timestamptz | Да | Время ответа | 2022-07-08T13:24:41.8328711+03:00 |
body{}
Атрибут | Тип | Обязательность | Описание | Пример |
---|---|---|---|---|
content[] | massive | Да | Массив, содержащий список доступных приложений | |
pageSize | string | Да | Размер страницы | Количество приложений для текущей пагинации |
continuationToken | string | Нет | Если список приложений продолжается на другой странице, API включает в ответ элемент continuationToken | Nzk0MjQ3Mzcw |
body.content[]
Атрибут | Тип | Обязательность | Описание | Пример |
---|---|---|---|---|
activePrice | number | Нет | Цена | 120 |
appId | number | Да | Идентификатор приложения | 478564 |
appName | string | Да | Название приложения | Приложение1 |
appStatus | string | Нет | Статус приложения | Возможные знaчения: • ACTIVE – версия опубликована;• PARTIAL_ACTIVE – версия опубликована на заданный процент пользователей;• READY_FOR_PUBLICATION – версия одобрена модератором;• PREVIOUS_ACTIVE – предыдущая активная версия;• ARCHIVED – версия находится в архиве;• REJECTED_BY_MODERATOR – версия отклонена модератором;• TAKEN_FOR_MODERATION – версия находится на модерации;• MODERATION – версия ожидает действий от модератора;• AUTO_CHECK – автоматическая проверка антивирусом Касперского;• AUTO_CHECK_FAILED – автоматическая проверка не пропустила APK;• DRAFT – черновик версии;• DELETED_DRAFT – черновик удалён;• REJECTED_BY_SECURITY – версия отклонена со стороны ИБ |
appVerUpdatedAt | timestamptz | Нет | Дата обновления версии | 2024-03-11T12:23:55.596998+03:00 |
companyName | string | Да | Название компании | Компания пример |
deviceType | string | Нет | Тип устройства | MOBILE |
iconUrl | string | Нет | Ссылка на иконку приложения | Ссылка на иконку |
packageName | string | Да | Наименование пакета приложения | com.myapp.example |
paid | bool | Нет | Платное или нет | true /false |
shortDescription | string | Нет | Краткое описание | Краткое описание приложения |
versionCode | number | Нет | Код версии | 1 |
versionName | string | Нет | Название версии | 1.0 |
Возможные ошибки
code | message | Описание | Действия |
---|---|---|---|
400 | pageSize must be not null in range [1,1000] | Неправильно указано значение pageSize | Проверьте, что вы верно указали значение параметра pageSize |
400 | Invalid request content | Введены неверные данные параметров | Проверьте, что вы верно указали значения параметров |
400 | if one of orderFields sortDirections is not null other param should be also not null | Не хватает данных по сортировке | Параметры orderFields и sortDirections должны указываться вместе |
Пример запроса
сurl --location 'https://public-api.rustore.ru/public/v1/application' \
--header 'Content-Type: application/json' \
--header 'Public-Token: {YOURtoken}'
Пример ответа
{
"code": "OK",
"message": "OK",
"body": {
"content": [
{
"appId": 478564,
"packageName": "com.example.myapplicativfsdvf",
"appName": "компания пример",
"iconUrl": "https://platform-s3.dev.rustore.devmail.ru/rustore-public-dev1/apk/478564/content/ICON/f6b95c5f-6c45-4359-988e-a9fd759c9416.jpg",
"appStatus": "PUBLISHED",
"versionName": "1.0",
"versionCode": 1,
"companyName": "companyName",
"shortDescription": "Краткое описание",
"appVerUpdatedAt": "2024-03-11T12:23:55.596998+03:00",
"activePrice": 0,
"paid": false,
"deviceType": "MOBILE"
}
],
"continuationToken": "TlRFeE56VXcuLi4u"
},
"timestamp": "2024-09-04T13:38:39.906714473+03:00"
}