채널
이 플러그인의 설치 단계와 전체 마크다운 가이드를 포함한 설정 지시를 복사하세요.
Capgo의 앱 업데이트를 관리하는 핵심 메커니즘인 채널입니다. 채널은 사용자가 업데이트를 받는 방법과 때를 제어할 수 있게 해주며, A/B 테스트, 단계별 롤아웃, 플랫폼별 업데이트와 같은 기능을 활성화합니다.
채널 이해
“채널 이해”라는 제목의 섹션채널은 앱 업데이트의 배포 트랙을 나타냅니다. 각 채널은 특정 규칙과 제약을 구성할 수 있습니다:
- 배포 버전 제어: 사용자가 받는 배포 버전을 지정합니다
- 플랫폼 대상 설정: iOS/Android/Electron과 같은 특정 플랫폼을 대상으로 설정합니다
- 업데이트 정책: 업데이트 전달 방법을 제어합니다.
- 기기 제한: 업데이트에 접근할 수 있는 기기를 관리합니다.
채널 구성 옵션
: 채널 구성 옵션 섹션 제목- 공개: 새로운 기기에 기본 채널로 설정합니다.
- disableAutoUpdateUnderNative: 채널의 안정화 패키지보다 기기의 네이티브 앱 버전이 최신일 때 업데이트를 차단합니다.
- 자동 업데이트 차단: 업데이트 동작을 제어합니다.
major,minor,metadata,patch또는none). - ios/android/electron: 플랫폼별 전달을 허용하거나 차단합니다.
- allow_device_self_set: 장치가 채널을 선택할 수 있도록 허용합니다.
- allow_emulator, allow_device, allow_dev, allow_prod: 업데이트 받을 장치 및 빌드 타입을 제어합니다.
- 점진적 롤아웃: 안정적인 번들을 유지하면서 특정 그룹에만 노출되는 타겟 번들을 유지합니다. See __CAPGO_KEEP_0__.
__CAPGO_KEEP_1__
__CAPGO_KEEP_2__- __CAPGO_KEEP_3____CAPGO_KEEP_4__
- __CAPGO_KEEP_5____CAPGO_KEEP_6__
- __CAPGO_KEEP_7____CAPGO_KEEP_8__
- __CAPGO_KEEP_9____CAPGO_KEEP_10__ __CAPGO_KEEP_11__ 업데이트 경로를 명확하게 하기 위해
엔드포인트
엔드포인트POST
POSThttps://api.capgo.app/channel/
채널 구성 설정을 만들거나 업데이트합니다.
요청 본문
요청 본문type DisableAutoUpdate = "major" | "minor" | "metadata" | "patch" | "none"type AutoPauseAction = "pause" | "rollback" | "notify"
interface ChannelSet { app_id: string channel: string version?: string | null // stable bundle name public?: boolean disableAutoUpdateUnderNative?: boolean disableAutoUpdate?: DisableAutoUpdate ios?: boolean android?: boolean electron?: boolean allow_device_self_set?: boolean allow_emulator?: boolean allow_device?: boolean allow_dev?: boolean allow_prod?: boolean
// Progressive rollout (camelCase is preferred) rolloutVersion?: string | number | null // target bundle name or ID rolloutPercentage?: number // 0–100 rolloutPercentageBps?: number // 0–10000; takes precedence when both are set rolloutEnabled?: boolean rolloutPaused?: boolean // input-only convenience flag rolloutPausedAt?: string | null // ISO timestamp or null rolloutPauseReason?: string | null rolloutCacheTtlSeconds?: number // 60–31536000 rollback?: boolean promoteToStable?: boolean
// Rollout auto-pause policy autoPauseEnabled?: boolean autoPauseWindowMinutes?: number autoPauseFailureRateBps?: number | null autoPauseConfidence?: number autoPauseMinAttempts?: number | null autoPauseMinFailures?: number | null autoPauseAction?: AutoPauseAction autoPauseCooldownMinutes?: number}롤아웃 및 자동 일시정지 필드의 경우 API도 해당하는 snake_case 형식, 예를 들어 rollout_version 또는 auto_pause_enabled. 만 제공되는 경우, camelCase 값이 우선합니다. rollback camelCase만.
롤아웃 대상은 기존 채널이 필요합니다. 안정적인 번들을 할당하거나 POST 요청을 통해 받을 수 있어야 합니다. version 동일한 POST 요청. rollback 및 promoteToStable are terminal actions; 다른 것을 결합하지 마십시오.
예제 요청
제목이 “예제 요청”인 섹션기존에 설정된 안정적인 번들을 가진 채널에 대해 5%의 롤아웃을 구성하십시오. production 터미널 창
curl -X POST \ -H "authorization: your-api-key" \ -H "Content-Type: application/json" \ -d '{ "app_id": "com.example.app", "channel": "production", "rolloutVersion": "1.3.0", "rolloutPercentage": 5, "rolloutEnabled": true, "rolloutCacheTtlSeconds": 2592000, "autoPauseEnabled": true, "autoPauseFailureRateBps": 500, "autoPauseMinAttempts": 100, "autoPauseAction": "pause" }' \ https://api.capgo.app/channel/성공 응답
성공 응답 섹션{ "status": "ok"}POST는 업데이트를 포함하고 상태만 반환합니다. 결과 채널 구성 읽기 위해 GET 요청을 만들세요.
앱 미리보기 키 경계
앱 미리보기 키 경계 섹션최소 권한의 PR 미리보기에 대해 이 엔드포인트를 인증하세요. authorization: $CAPGO_API_KEY 또는 capgkey: $CAPGO_API_KEY헤더는 채널의 __CAPGO_KEEP_0__에 의해 수락되지 않습니다. x-api-key header is not accepted by the Channels API.
An app_preview key channel.update_settingsPOST를 사용하여 기존 채널(기본 채널 포함)을 업데이트할 수 없으므로, POST를 사용하여 기존 채널(기본 채널 포함)을 업데이트할 수 없습니다. 기존 기본 채널 또는 메인 채널을 업데이트할 수 없습니다.
Leave public 기본값 (또는 PR 미리보기 채널에 대해 false)으로 두세요. 미리보기 채널을 만들고 업로드 흐름을 위해 POST 대신 사용하세요. bundle upload --channel GET
https://api.capgo.app/channel/
, 응답은 배열입니다. With channel, 응답은 하나의 채널 객체입니다. channelQuery Parameters
Query Parameters 섹션 제목
기존 채널(기본 채널 포함)을 업데이트할 수 없으므로, POST를 사용하여 기존 채널(기본 채널 포함)을 업데이트할 수 없습니다. 기존 기본 채널 또는 메인 채널을 업데이트할 수 없습니다. Leaveapp_id: __CAPGO_KEEP_0__이 필요합니다. 앱의 ID를 입력하세요.page: __CAPGO_KEEP_0__이 필요합니다. 페이지 번호를 입력하세요.channel: __CAPGO_KEEP_0__이 필요합니다. 특정 채널 이름을 입력하세요.
예제 요청
예제 요청 섹션# Get all channelscurl -H "authorization: your-api-key" \ "https://api.capgo.app/channel/?app_id=com.example.app"
# Get a specific channelcurl -H "authorization: your-api-key" \ "https://api.capgo.app/channel/?app_id=com.example.app&channel=production"
# Get the next pagecurl -H "authorization: your-api-key" \ "https://api.capgo.app/channel/?app_id=com.example.app&page=1"응답 유형
응답 유형 섹션interface Channel { id: number created_at: string updated_at: string name: string app_id: string created_by: string public: boolean disableAutoUpdateUnderNative: boolean disableAutoUpdate: DisableAutoUpdate allow_device_self_set: boolean allow_emulator: boolean allow_device: boolean allow_dev: boolean allow_prod: boolean version: { id: number, name: string } | null // stable bundle
// These three response identifiers intentionally use snake_case. rollout_version: number | null rollout_id: string rollout_version_info: { id: number, name: string } | null
rolloutPercentageBps: number rolloutEnabled: boolean rolloutPausedAt: string | null rolloutPauseReason: string | null rolloutCacheTtlSeconds: number autoPauseEnabled: boolean autoPauseWindowMinutes: number autoPauseFailureRateBps: number | null autoPauseConfidence: number autoPauseMinAttempts: number | null autoPauseMinFailures: number | null autoPauseAction: AutoPauseAction autoPauseCooldownMinutes: number autoPauseLastTriggeredAt: string | null autoPauseLastCheckedAt: string | null}rolloutPaused 단축키는 입력 전용이며 반환되지 않습니다. 중단된 롤아웃은 null이 아닌 값을 나타냅니다. rolloutPausedAt.
[ { "id": 1, "name": "production", "app_id": "com.example.app", "version": { "id": 1, "name": "1.2.0" }, "rollout_version": 2, "rollout_id": "e60c19c9-2e65-4e0d-bc06-d1f5b4f96276", "rollout_version_info": { "id": 2, "name": "1.3.0" }, "rolloutPercentageBps": 500, "rolloutEnabled": true, "rolloutPausedAt": null, "rolloutCacheTtlSeconds": 2592000, "autoPauseEnabled": true, "autoPauseFailureRateBps": 500, "autoPauseAction": "pause" }]DELETE
Section titled “DELETE”https://api.capgo.app/channel/
채널 삭제. 이 채널을 사용하는 모든 기기에 영향을 줄 수 있습니다.
Request Body
Section titled “Request Body”interface Channel { channel: string app_id: string delete_bundle?: boolean // also delete the linked bundle}curl -X DELETE \ -H "authorization: your-api-key" \ -H "Content-Type: application/json" \ -d '{ "app_id": "com.example.app", "channel": "beta" }' \ https://api.capgo.app/channel/성공 응답
성공 응답 섹션{ "status": "ok"}앱 미리보기 정리
앱 미리보기 정리 섹션그리고 delete_bundle: true, app_preview 키는 만든 채널과 연결된, 공유되지 않은 패키지만 atomically 정리할 수 있습니다. 키는 일반 bundle.delete 권한을 받지 않습니다.
curl -X DELETE \ -H "capgkey: $CAPGO_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "app_id": "com.example.app", "channel": "pr-123", "delete_bundle": true }' \ https://api.capgo.app/channel/오류 처리
에러 처리일반적인 오류 상황과 그에 대한 응답:
// Channel not found{ "error": "Channel not found", "status": "KO"}
// Invalid bundle (version) format{ "error": "Invalid version format. Use semantic versioning", "status": "KO"}
// Invalid update policy{ "error": "Invalid disableAutoUpdate value", "status": "KO"}
// Permission denied{ "error": "Insufficient permissions to manage channels", "status": "KO"}일반적인 사용 사례
Section titled “일반적인 사용 사례”- 베타 테스트
{ "app_id": "com.example.app", "channel": "beta", "version": "1.2.0-beta", "public": false, "allow_emulator": true, "allow_dev": true}- 운영 배포
{ "app_id": "com.example.app", "channel": "production", "version": "1.2.0", "public": true, "disableAutoUpdate": "minor"}- 플랫폼별 업데이트
{ "app_id": "com.example.app", "channel": "ios-hotfix", "version": "1.2.1", "ios": true, "android": false}__CAPGO_KEEP_0__
__CAPGO_KEEP_0____CAPGO_KEEP_1__ __CAPGO_KEEP_2__ __CAPGO_KEEP_3__ __CAPGO_KEEP_4__ __CAPGO_KEEP_5__ __CAPGO_KEEP_6__ __CAPGO_KEEP_7__ __CAPGO_KEEP_8__ __CAPGO_KEEP_9__ __CAPGO_KEEP_10__ __CAPGO_KEEP_11__ Capgo 환경 설정 최적화: 단일 모바일 앱 ID를 사용한 스테이징 Capgo 환경 설정 최적화: 단일 모바일 앱 ID를 사용한 스테이징을 위한 실제 상황.