アプリ

インストール手順とこのプラグインの完全なマークダウンガイドを含むセットアップ用の質問をコピーする

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: アプリケーションの固有識別子
Name: アプリケーションの人間が読める名前
Icons: ダッシュボード上のアプリの視覚的識別子
Configuration: アップデートの配信方法を制御する設定
Ownership: 組織とユーザーへのアクセス情報
Usage Statistics: インストールとアップデートに関するメトリクス

Best Practices

命名規則: アプリの明確で識別可能な名前を使用してください
セキュリティ: API キーとアクセス資格を保護してください
組織: 関連するアプリを同じ組織下にグループ化してください
監視: アプリの統計とパフォーマンスを定期的に確認してください
バックアップ: 重要なアプリの構成バックアップを維持してください

エンドポイント

GET

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

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

クエリパラメータ

page__CAPGO_KEEP_0__ (オプション): ページ番号 (ページネーション用)
limit__CAPGO_KEEP_1__ (オプション): 1 ページあたりの結果数 (デフォルト: 50)
org_id__CAPGO_KEEP_2__ (オプション): 組織 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パスに指定されています。

Request Body

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

削除

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"

リソース管理

ストレージ最適化: ストレージ使用量を監視し、適切な保持ポリシーを設定
組織: 関連アプリを単一の組織下にグループ化
アクセス制御: チームメンバーがアプリ設定を変更できるように管理
バックアップ戦略: 重要なアプリ設定と構成をバックアップ

続けてアプリを管理

__CAPGO_KEEP_0__を利用している場合 Apps APIと接続して APIの概要 APIの概要の実装詳細については導入導入の実装詳細については APIのキー APIのキーについての実装詳細についてはデバイスデバイスについての実装詳細についてはバンドルバンドルの実装詳細について

アプリ

__CAPGO_KEEP_2__アプリの設定を使用すると、アプリの設定を作成、取得、更新、削除できます。

Best Practices

エンドポイント

GET

クエリ パラメータ

レスポンスのタイプ

例:リクエスト

例:レスポンス

POST

リクエストボディ

例のリクエスト

成功レスポンス

PUT

Request Body

例:リクエスト

成功レスポンス

削除

例のリクエスト

成功応答

エラー処理

一般的な使用例

リソース管理

続けてアプリを管理

クエリパラメータ