Apps

이 설정 프롬프트를 설치 단계와 이 플러그인의 전체 마크다운 가이드와 함께 복사합니다.

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.

앱 이해

An app in Capgo represents your Capacitor application and includes:

앱 ID: 애플리케이션의 고유 식별자입니다.
이름: 사용자가 읽을 수 있는 애플리케이션의 이름입니다.
아이콘: 대시보드에서 앱의 시각적 식별자입니다.
설정: 업데이트가 전달되는 방법을 제어하는 설정입니다.
소유권: 조직 및 사용자 접근 정보입니다.
사용 통계: 설치 및 업데이트에 대한 메트릭입니다.

최적화 방법

이름 규칙이름 지정 규칙
보안: API 키와 접근 자격 증명을 보호하세요
조직: 관련 앱을 동일한 조직 아래 그룹화하십시오
모니터링: 앱 통계 및 성능을 정기적으로 확인하십시오
백업: 중요한 앱의 구성 백업을 유지하십시오

엔드포인트

GET

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

앱에 대한 정보를 가져옵니다.

Query Parameters

page: 옵션. 페이지네이션을 위한 페이지 번호
limit: 옵션. 한 페이지당 결과 수 (기본값: 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"
    }
  ]
}

클립보드 복사

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

기존 앱을 업데이트합니다. URL 경로에 앱 ID가 지정되어 있습니다.

요청 본문

interface UpdateApp {
  block_provider_infra_requests?: boolean
  name?: string
  icon?: string
  retention?: number
}

페이지/영역: Capgo 마케팅 웹사이트. 역할: UI 레이블. 표시되는 곳: page agents/[slug].astro. 메시지 키 `agents_page_copy_label` (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"
}

일반 사용 사례

앱 구성 업데이트

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

__CAPGO_KEEP_0__

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

자원 관리

저장소 최적화: 저장소 사용량을 모니터링하고 적절한 보존 정책을 설정합니다.
조직: 관련 앱을 단일 조직 아래 그룹화합니다.
접근 제어: 앱 설정을 수정할 수 있는 팀 멤버를 관리합니다.
백업 전략: 중요한 앱 구성 및 설정을 백업합니다.

앱에서 계속 진행하세요

앱을 사용 중이라면 앱 앱을 계획하고 API 작업을 관리하기 위해 API과 연결하세요 API 개요 API 개요에서 구현 세부 정보를 참조하세요 소개 소개에서 구현 세부 정보를 참조하세요 API 키 API 키에서 구현 세부 정보를 참조하세요 장치 장치에 대한 구현 세부 정보를 위해 배너 배너에 대한 구현 세부 정보를 위해