A public API JSON HTTP 요청과 응답을 통해 구조화된 데이터를 소프트웨어가 교환할 수 있는 인터페이스를 제공합니다. Capgo의 유형화된 RESTful API는 CapacitorJS와 Electron 팀이 라이브 업데이트, 채널, 번들 및 장치 전달에 대한 프로그래밍적 제어를 제공합니다.
내용목록
Understanding Capgo Public API JSON 기초
Capgo isn’t a general-purpose data directory. Its public API JSON interface connects your build system with Capgo’s cloud delivery service, so release automation can publish and direct signed web bundles without waiting for App Store or Play review. REST uses familiar HTTP methods such as GET, POST, PUT, PATCH, DELETE이 REST API 가이드 (Postman).
Capgo 에서 JSON은 자동화 스크립트, CI/CD 작업, TypeScript 클라이언트 및 배포 플랫폼 간의 공유 언어입니다. 이 일관성은 로그에서 페이로드를 읽고 배포가 시작되기 전에 유효성을 검사하는 것을 단순화합니다.
인터페이스 제어
운영 배포 자원 관리를 위해 공개 API JSON 엔드포인트를 사용하세요.
- Bundles릴리스 채널
- Channels예를 들어, 스테이징, 베타, 프로덕션, 고객 전용 릴리스 스트림
- 버전릴리스 채널에 할당된 빌드의 식별과 추적
- 디바이스 타겟팅, 앱 버전, 운영 체제, 또는 메타데이터 그룹을 선택한 플랫폼으로 릴리스를 지시하는 데 도움이 됩니다.
- 관찰성 데이터, 포함하여 도입, 실패, 롤백 활동 및 장치별 상태.
일반적인 요청은 예측 가능한 순서로 진행됩니다. pipeline은 또는 버블을 생성하거나 준비하고, JSON 메타데이터를 Capgo로 전송하고, 반환된 상태를 확인하고, 나중에 할당된 릴리스를 적절한 채널에 assign합니다. 나중에 쿼리는 업데이트 받은 장치가 어떤 장치인지 확인할 수 있습니다.
주요 아이디어: Capgo JSON을 릴리스 제어 계약으로 대우하십시오. 단순한 데이터 형식으로만 보지 마십시오. 모든 field는 릴리스 업데이트를 위한 public, targeting, monitoring, 또는 recovery를 지원해야 합니다.
왜 타입화된 JSON이 도움이 되는가?
타입화된 페이로드는 TypeScript 코드베이스에서 모호성을 줄입니다. 버전 식별자는 문자열로, 롤아웃 플래그는 Boolean으로, 장치 수는 숫자로 유지되어야 합니다. 자동화 연결하기 전에 요청 및 응답에 대한 인터페이스를 정의하고, 필수 필드와 nullable 값을 검증하십시오.
또 읽어보세요 API와 함께 TypeScript 사용하는 방법에 대해 더 알아보십시오..
모든 통합에 세 가지 습관을 유지하십시오:
- 상태 코드와 응답 본문을 함께 검사하십시오.HTTP 성공만으로도 배포 완료 여부를 설명하지 못할 수 있습니다.
- 반환된 식별자를 보존하세요.특히, 이후 호출에 사용할 수 있도록 버전, 채널 ID, 및 번들 ID를 보존하세요.
- 안전하게 로그하세요.API 키 및 sensitive 장치 데이터를 제외한 경우.
다음 참조 섹션은 인증, 업로드 페이로드, 채널 스키마, 타겟팅 쿼리, 및 오류 객체를 설명하는 데 이 기초를 사용합니다. 현재 엔드포인트 이름 및 field 정의를 확인하려면 Capgo의 문서를 확인하세요. capgo.app.
{ “인증”: “Bearer YOUR_CAPGO_API_KEY”, “콘텐츠 유형”: “application/json”, “accept”: “application/json” }
{ “성공”: true, “번들 ID”: “com.example.field-app”, “버전”: “2.4.0”, “상태”: “업로드됨”, “번들 UUID”: “생성된 번들 식별자”, “생성일”: “2026-01-15T10:30:00Z” }
{ “기본 버전”: “2.4.3”, “자동 업데이트”: true, “롤백 보호”: { “활성화”: true, “fallback 버전”: “2.4.2” } }
{ “데이터”: [ { “시간대”: “2026-02-04T09:00:00Z”, “설치”: 842, “롤백”: 3, “오류”: 11 }, { “시간대”: “2026-02-04T10:00:00Z”, “설치”: 1276, “롤백”: 2, “오류”: 8 } ], “요약”: { “총 설치”: 2118, “총 롤백”: 5, “총 오류”: 19 } }
{ “오류”: { “code”: “INVALID_PARAMETER”, “메시지”: “버전 필드는 필수입니다”, “field”: “version”, “상세”: { “예상”: “문자열”, “받은”: “null” } } }
{"version": "2.4.0",\n"checksum": "sha256-value",\n"encryption": true,\n"externalUrl": ""https://storage.example/zip파일.bundle” }
