アプリ

Apps are the foundational entities in Capgo. Each app represents a unique Capacitor application that you can manage and update through the platform. The Apps API allows you to create, retrieve, update, and delete app configurations.

アプリは、__CAPGO_KEEP_2__を通じて作成、取得、更新、および削除することができます。

An app in Capgo represents your Capacitor application and includes:

• __CAPGO_KEEP_0__のアプリは、__CAPGO_KEEP_1__アプリケーションを表し、以下の要素を含みます。アプリID
• :アプリケーションに一意の識別子名前
• :アプリケーションの人間が読める名前アイコン
• :ダッシュボード上でアプリの視覚的識別子設定
• 所有権: 組織とユーザー アクセス情報
• 使用状況統計: インストールと更新に関するメトリクス

ベスト プラクティス

1. 命名規則: アプリの名前を明確で識別可能なものにします
2. セキュリティ: API キーとアクセス クレデンシャルを保護する
3. 組織: 関連するアプリを同じ組織にグループ化する
4. 監視: アプリ統計とパフォーマンスを定期的に確認する
5. バックアップ: 重要なアプリの構成バックアップを維持する

エンドポイント

アプリに関する情報を取得します。

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

クエリ パラメーター

: オプション。 ページネーションの場合のページ番号

• page__CAPGO_KEEP_1__
• limit: __CAPGO_KEEP_0__ (default: 50)
• org_id: __CAPGO_KEEP_0__ を指定すると、ユーザーがアクセスできるすべての組織のアプリを返します

特定のアプリを取得するには

• 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/

新しいアプリを作成します。

リクエストボディ

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"
}

一般的な使用例

1. 新しいアプリを作成

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

2. アプリケーション設定の更新

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

3. 保持ポリシーの設定

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

4. 組織ごとのアプリの取得

# 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"

リソース管理

1. ストレージ最適化ストレージ使用量の監視と適切な保持ポリシーの設定
2. 組織: グループ化されたアプリを 1 つの組織下にまとめる
3. Access Control: アプリ設定を変更できるチームメンバーを管理する
4. Backup Strategy: アプリの重要な設定と構成をバックアップする