アプリ

アプリはCapgoの基本的なエンティティです。各アプリは、Capacitorアプリケーションを表し、プラットフォームを通じて管理および更新できます。アプリのAPIは、アプリの構成を生成、取得、更新、削除することを可能にします。

アプリの理解

Capgoのアプリは、Capacitorアプリケーションを表し、以下を含みます:

• App ID: アプリケーションの固有識別子
• Name: ユーザーが読みやすいアプリケーションの名前
• Icons: ダッシュボード上のアプリの視覚的識別子
• Configuration: アップデートの配信方法を制御する設定
• Ownership: 組織とユーザーへのアクセス情報
• Usage Statistics: インストールとアップデートに関するメトリクス

ベスト プラクティス

1. ネーミング コン벤ションアプリ名は明確で識別可能なものを使用してください
2. セキュリティ保護するには、API キーとアクセス クレデンシャルを保護してください
3. 組織関連アプリを同じ組織下にグループ化してください
4. 監視アプリ統計とパフォーマンスを定期的に確認してください
5. バックアップ重要なアプリの構成バックアップを維持してください

エンドポイント

GET

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

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

クエリパラメータ

• page: オプション。ページ番号(分割時)
• limit: オプション。1ページあたりの結果数(デフォルト: 50)
• org_id: オプション。組織IDでアプリをフィルタリングします。指定しない場合は、ユーザーがアクセスできるすべての組織のアプリを返します。

特定のアプリを取得する場合:

• URLパスにアプリIDを使用してください: https://api.capgo.app/app/:app_id

レスポンスタイプ

注意: last_version アプリの最後にアップロードされたバンドル（バージョン）を指します。

interface App {
  app_id: string
  block_provider_infra_requests: boolean
  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": [
    {
      "block_provider_infra_requests": true,
      "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/

成功レスポンス

{
  "block_provider_infra_requests": true,
  "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 {
  block_provider_infra_requests?: boolean
  name?: string
  icon?: string
  retention?: number
}

例

curl -X PUT \
  -H "authorization: your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "block_provider_infra_requests": true,
    "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",
  "block_provider_infra_requests": true,
  "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. 組織: 相関のあるアプリを単一の組織下にグループ化する
3. アクセス制御: チームメンバーがアプリ設定を変更できるように管理する
4. バックアップ戦略: バックアップする重要なアプリ設定と設定

Apps

アプリから続ける アプリを使用している場合 to plan dashboard and API operations, connect it with を計画ダッシュボードとAPIの実行に接続する APIの概要 実装の詳細については__CAPGO_KEEP_0__の概要を参照してください 導入 API Keys APIのキー デバイス デバイスの実装詳細について バンドル バンドルの実装詳細について