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

# CloudX API

> 了解如何认证请求并使用 CloudX API 参考。

# CloudX API

使用 CloudX API 获取报表指标、检查竞价，并读取或写入账号配置。

## 基础 URL

```text theme={null}
https://provisioning.cloudx.io/api/v1
```

## 认证

在 [Settings > API Keys](https://app.cloudx.io/settings/api-keys) 中创建 API key，然后将它作为 bearer token 发送：

```bash theme={null}
curl https://provisioning.cloudx.io/api/v1/auth/status \
  -H "Authorization: Bearer $CLOUDX_API_KEY"
```

只有管理员可以创建、管理和撤销 API key。

## 权限

根据集成需要调用的端点选择权限。

| 权限                    | 允许访问                  |
| --------------------- | --------------------- |
| `reports:read`        | `/report/*` 下的报表端点    |
| `auctions:read`       | `/auction/*` 下的竞价检查端点 |
| `configuration:read`  | `/config/*` 下的配置端点    |
| `configuration:write` | `/config/*` 下的配置写入端点  |

## 配置写入

使用 `POST /config/edit` 为应用、广告单元、广告单元组、列表、标签、测试设备、网络映射和订单项创建或更新配置草稿。该端点也支持 A/B 测试操作；创建 A/B 测试会返回草稿，更新、开始、结束、提升和删除会发布生成的配置。

请求使用带类型的操作键，例如 `create_app`、`update_ad_unit`、`upsert_network_mapping` 和 `update_line_item`。广告单元和订单项的 `bidfloor` 使用十进制 USD CPM，因此 `1.5` 表示 `$1.50` CPM。

## API 参考

API 参考由 CloudX 托管的实时 OpenAPI schema 生成。