应用

复制一个包含安装步骤和本插件的完整 Markdown 指南的配置提示。

在 Capgo 中，应用程序是基本的实体。每个应用程序代表一个独特的 Capacitor 应用程序，您可以通过平台管理和更新它。API 应用程序功能允许您创建、检索、更新和删除应用程序配置。

了解应用程序

在 Capgo 中，一个应用程序代表您的 Capacitor 应用程序，包括：

应用程序 ID: 代表您的应用程序的唯一标识符
: 代表您的应用程序的可读名称: 代表您的应用程序的图标
: 代表您的应用程序的图标: 应用程序在仪表板中的视觉标识
配置: 控制更新分发方式的设置
所有权: 机构和用户访问信息
使用统计: 安装和更新的指标

最佳实践

命名约定: 为应用程序使用清晰、可识别的名称
安全保护您的API密钥和访问凭证
组织:将相关应用程序分组到同一个组织
监控:定期检查应用程序统计和性能
备份:为关键应用程序维护配置备份

端点

GET

https://api.capgo.app/app/

获取有关您的应用程序的信息。

参数

page: 可选。分页的页码
limit: 可选。每页显示的结果数量（默认值：50）
org_id: 可选。按组织 ID 过滤应用。如果未提供，则返回用户有权访问的所有应用

获取特定应用：

在 URL 路径中使用应用 ID： https://api.capgo.app/app/:app_id

响应类型

注意： last_version 指的是应用的最后一个打包（版本）

interface App {
  app_id: string
  created_at: string | null
  default_upload_channel: string
  icon_url: string
  id: string | null
  last_version: string | null // last bundle (version) name
  name: string | null
  owner_org: string
  retention: number
  transfer_history: Json[] | null
  updated_at: string | null
  user_id: string | null
}

示例请求

# Get all apps
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/"

# Get apps from a specific organization
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/?org_id=046a36ac-e03c-4590-9257-bd6c9dba9ee8"

# Get specific app
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/com.demo.app"

示例响应

{
  "data": [
    {
      "app_id": "com.demo.app",
      "created_at": "2024-01-01T00:00:00Z",
      "default_upload_channel": "dev",
      "icon_url": "https://example.com/icon.png",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "last_version": "1.0.0",
      "name": "Demo App",
      "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8",
      "retention": 2592000,
      "transfer_history": null,
      "updated_at": "2024-01-01T00:00:00Z",
      "user_id": "6aa76066-55ef-4238-ade6-0b32334a4097"
    }
  ]
}

POST

https://api.capgo.app/app/

请求主体

POST

interface CreateApp {
  app_id: string
  name: string
  icon?: string
  owner_org: string
}

示例请求

# Create new app
curl -X POST \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New App",
    "app_id": "com.demo.myapp", // this id is unique in Capgo This cannot be reused by any account.
    "icon": "https://example.com/icon.png",
    "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8"
  }' \
  https://api.capgo.app/app/

成功响应

{
  "app_id": "My New App",
  "created_at": "2024-01-01T00:00:00Z",
  "default_upload_channel": "dev",
  "icon_url": "https://example.com/icon.png",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My New App",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8",
  "retention": 2592000,
  "updated_at": "2024-01-01T00:00:00Z"
}

PUT

https://api.capgo.app/app/:app_id

更新现有应用。应用程序ID在URL路径中指定。

请求主体

interface UpdateApp {
  name?: string
  icon?: string
  retention?: number
}

示例请求

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated App Name",
    "icon": "https://example.com/updated-icon.png",
    "retention": 45
  }' \
  https://api.capgo.app/app/com.demo.app

成功响应

{
  "app_id": "com.demo.app",
  "created_at": "2024-01-01T00:00:00Z",
  "default_upload_channel": "dev",
  "icon_url": "https://example.com/updated-icon.png",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Updated App Name",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8",
  "retention": 45,
  "updated_at": "2024-01-01T00:00:00Z"
}

DELETE

https://api.capgo.app/app/:app_id

删除应用程序和所有相关资源。应用程序ID在URL路径中指定。请谨慎使用此操作，因为它无法撤销。

示例请求

curl -X DELETE \
  -H "authorization: your-api-key" \
  https://api.capgo.app/app/com.demo.app

成功响应

{
  "status": "ok"
}

错误处理

常见错误场景和响应:

// App not found
{
  "error": "App not found",
  "status": "KO"
}

// Duplicate custom ID
{
  "error": "Custom ID already in use",
  "status": "KO"
}

// Invalid parameters
{
  "error": "Invalid app configuration",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage app",
  "status": "KO"
}

// Organization access denied
{
  "status": "You do not have access to this organization"
}

常见用例

创建新应用

// Set up a new app
{
  "name": "Production App",
  "owner_org": "046a36ac-e03c-4590-9257-bd6c9dba9ee8"
}

更新应用配置

// Change app name and icon
{
  "name": "Rebranded App Name",
  "icon": "https://example.com/new-icon.png"
}

设置保留策略

// Configure automatic bundle cleanup
{
  "retention": 30 // Keep bundles for 30 days
}

按组织获取应用

# List all apps in a specific organization
curl -H "authorization: your-api-key" \
  "https://api.capgo.app/app/?org_id=046a36ac-e03c-4590-9257-bd6c9dba9ee8"

资源管理

存储优化: 监控存储使用情况并设置合适的保留策略
组织: 将相关应用程序归类到一个单独的组织
访问控制: 管理哪些团队成员可以修改应用程序设置
备份策略: 备份关键应用程序配置和设置