アプリ

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

アプリの理解

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

• アプリID: アプリケーションの固有識別子
• 名前アプリケーションの名前
• アイコンアプリのビジュアル識別子
• 設定更新の配信方法を制御する設定
• 所有権組織とユーザーへのアクセス情報
• 使用状況の統計インストールと更新に関するメトリクス

ベストプラクティス

1. 命名規則: アプリの名前を明確で識別可能な名前で設定してください。
2. Security: API キーとアクセス資格を保護してください。
3. Organization: 関連するアプリを同じ組織下にグループ化してください。
4. Monitoring: アプリの統計とパフォーマンスを定期的に確認してください。
5. Backup: 重要なアプリの設定をバックアップしてください。

Endpoints

GET

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

アプリの情報を取得します。

Query Parameters

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

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

• URL パスにアプリ ID を使用します。 https://api.capgo.app/app/:app_id

Response Type

注意: last_version __CAPGO_KEEP_0__を最後にアップロードしたアプリのバージョンです。

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
}

__CAPGO_KEEP_1__の例

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

__CAPGO_KEEP_4__の例

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

__CAPGO_KEEP_6__

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

__CAPGO_KEEP_0__をクリップボードにコピー、”新しいアプリを作成します。

Request Body

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. アクセス制御チームメンバーがアプリ設定を変更できるものを管理
4. バックアップ戦略重要なアプリ設定と構成をバックアップ

Appsから続けて

If you are using __CAPGO_KEEP_0__ アプリ を計画ダッシュボードとAPI オペレーションに接続する API オーバービュー API オーバービューの実装詳細について 導入 導入の実装詳細について API キー API キーの実装詳細について デバイス デバイスの実装詳細について バンドル __CAPGO_KEEP_0__の実装詳細については、Bundlesにあります。