> ## Documentation Index
> Fetch the complete documentation index at: https://docs.acedata.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Получение списка заявок на услуги платформы AceDataCloud

> Platform API guide - Ace Data Cloud

С постраничным возвратом Application, которыми владеет учетная запись или на использование которых она уполномочена, включая баланс, статус, сводку услуги и связанные учетные данные. Подходит для пакетного мониторинга баланса, поиска Application ID и перехода к управлению учетными данными.

## Подготовка

1. Войдите на [платформу AceDataCloud](https://platform.acedata.cloud).
2. Создайте токен учетной записи в [консоли Account Token](https://platform.acedata.cloud/console/platform-tokens).
3. Обычные пользователи используют `user_id=me`; также можно получить собственный UUID через `GET /api/v1/platform-tokens/me/`.

```shell theme={null}
export PLATFORM_TOKEN='ваш токен учетной записи'
```

## Обзор интерфейса

| Пункт | Содержание |
| - | - |
| Метод | `GET` |
| URL | `https://platform.acedata.cloud/api/v1/applications/` |
| Авторизация | Account Token, OAuth token требует `applications:read` |
| Пагинация | `count` + `items` |

Обычные пользователи должны передавать `user_id=me`. Если не передавать его, запрос изначально не сужается по учетной записи, и при пагинации при встрече объектов без доступа может вернуться `403`; администраторы могут просматривать всю таблицу, не передавая его.

## Параметры запроса

| Параметр | Тип | Обязательный | Описание |
| - | - | - | - |
| `user_id` | UUID / `me` | Обязателен для обычных пользователей | Субъект запроса; поддерживает повторяющиеся параметры |
| `affiliation` | string | Нет | `owner` (по умолчанию) или `granted`; можно повторно передать оба для получения объединения, действует только при наличии `user_id` |
| `service_id` | UUID | Нет | Фильтрация по услуге; поддерживает повторяющиеся параметры |
| `scope` | string | Нет | `Individual` или `Global`; поддерживает повторяющиеся параметры |
| `type` | string | Нет | `Usage` или `Period`; поддерживает повторяющиеся параметры |
| `limit` | integer | Нет | Количество записей на страницу, максимум 100 |
| `offset` | integer | Нет | Смещение пагинации |
| `ordering` | string | Нет | Поддерживаются только `created_at` или `-created_at` |

`paid`, `disabled`, `expired`, `low_balance` и `tag` в настоящее время не являются параметрами серверной фильтрации. Для предупреждений о балансе следует получить список, а затем определять на клиенте на основе `remaining_amount`, `service.unit` и бизнес-порогов каждого Application.

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

```shell theme={null}
curl --get 'https://platform.acedata.cloud/api/v1/applications/' \
  --data-urlencode 'user_id=me' \
  --data-urlencode 'affiliation=owner' \
  --data-urlencode 'limit=100' \
  -H "Authorization: Bearer ${PLATFORM_TOKEN}"
```

Одновременный просмотр Application, которыми вы владеете, и тех, которые другие авторизовали для вас:

```shell theme={null}
curl --get 'https://platform.acedata.cloud/api/v1/applications/' \
  --data-urlencode 'user_id=me' \
  --data-urlencode 'affiliation=owner' \
  --data-urlencode 'affiliation=granted' \
  -H "Authorization: Bearer ${PLATFORM_TOKEN}"
```

## Описание ответа

Ответ имеет вид `{count, items}`. Каждый элемент содержит поля модели Application, а также:

* `service`: `id`, `alias`, `title`, `type`, `unit`, `icon_url`;
* `credentials`: сводка учетных данных, которые текущий вызывающий имеет право видеть;
* `paid`, `remaining_amount`, `used_amount`, `disabled`, `allow_consume_global`;
* фактическое значение `scope` — `Individual` или `Global`;
* фактическое значение `type` — `Usage` или `Period`.

`remaining_amount` может быть пустым; клиент должен сначала проверить его на пустоту, а затем выполнять числовое сравнение. Единица квоты определяется `service.unit`.

## Следующий шаг

* [Запрос сведений об отдельном Application](https://platform.acedata.cloud/documents/platform-application-detail)
* [Краткое руководство по мониторингу баланса](https://platform.acedata.cloud/documents/application-remaining-amount)
* [Создание учетных данных API](https://platform.acedata.cloud/documents/platform-credential-create)
* [Создание заказа на пополнение](https://platform.acedata.cloud/documents/platform-order-create)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.