Apps

Capgoのアプリは、Capacitorアプリケーションを表します。これらのアプリケーションを管理および更新することができます。Capgoのアプリは、APIを使用して作成、取得、更新、削除できます。

アプリの理解

Capgoのアプリは、Capacitorアプリケーションを表します。これには以下の要素があります。

• アプリID: {0} (アプリケーション ID)
• アプリケーション名: アプリケーション名 (人間が読みやすい)
• アイコン: ダッシュボード上のアプリの視覚的識別子
• 設定: アップデートの配信方法を制御する設定
• 所有権: 組織とユーザーへのアクセス情報
• 使用状況統計: インストールとアップデートに関するメトリクス

ベスト プラクティス

1. 命名規則：アプリケーションに明確で識別可能な名前を使用する
2. Security：APIキーとアクセス資格を保護する
3. Organization：関連するアプリケーションを同じ組織にグループ化する
4. Monitoring：アプリケーションの統計とパフォーマンスを定期的に確認する
5. Backup：重要なアプリケーションの構成バックアップを維持する

Endpoints

GET

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

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

クエリ パラメータ

• pageページ番号 (省略可能):
• limit1 ページあたりの結果数 (デフォルト: 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
}

コンテキスト: Capgo マーケティング ウェブサイト。役割: UI ラベル。表示される場所: ページエージェント/[スラッグ].astro。メッセージキー `agents_page_copy_label` (エージェント ページ コピー ラベル)。

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

POST

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

コンテキスト: Capgo マーケティング ウェブサイト。役割: UI ラベル。表示場所: ページエージェント/[slug].astro。メッセージキー `agents_page_copy_label` (エージェント ページ コピー ラベル)。

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から続ける

あなたがAppsを使用している場合 Apps 「Appsを使用して、計画ダッシュボードとAPIの運用を接続することができます。 APIの概要 「APIの概要」 Introduction 導入 API キー API キーの実装詳細について Devices デバイスの実装詳細について バンドル バンドルの実装詳細について