어떤 공개 API JSON interface는 소프트웨어가 HTTP 요청과 응답을 통해 구조화된 데이터를 교환하도록 합니다. Capgo의 타입 지정된 RESTful API은 CapacitorJS 및 Electron 팀이 라이브 업데이트, 채널, 번들, 디바이스 배포를 프로그래매틱하게 제어할 수 있게 합니다.
목차
Capgo 공개 API JSON 기본 개념 이해하기
Capgo은 범용 데이터 디렉터리가 아닙니다. 공개 API JSON 인터페이스는 빌드 시스템을 Capgo의 클라우드 배포 서비스와 연결하여, 앱 스토어나 플레이 스토어 리뷰를 기다리지 않고 서명된 웹 번들을 게시하고 배포할 수 있도록 릴리스 자동화를 지원합니다. REST는 다음과 같은 익숙한 HTTP 메서드를 사용합니다. GET, POST, PUT, PATCH, DELETE, JSON은 일반적으로 응답 형식으로 사용되며, 이 문서에서 설명하듯 Postman의 REST API 가이드.
Capgo에서 JSON은 자동화 스크립트, CI/CD 작업, TypeScript 클라이언트, 배포 플랫폼 간의 공통 언어입니다. 이러한 일관성은 로그에서 페이로드를 가독성 있게 만들고, 배포 시작 전 검증하기 쉽게 만듭니다.
인터페이스가 제어하는 것
공개 API JSON 엔드포인트를 사용하여 운영 릴리스 리소스를 관리합니다. 대상은 다음과 같습니다:
- 번들배포 가능한 업데이트를 구성하는 웹 자산 및 메타데이터입니다.
- 채널staging, beta, production 또는 고객 전용 릴리스 스트림과 같은 채널입니다.
- 버전해당 채널에 할당된 빌드를 식별하고 추적하는 빌드입니다.
- 디바이스 타겟팅선택된 플랫폼, 앱 버전, 운영체제 또는 메타데이터 그룹으로 릴리스를 전달하는 데 도움이 됩니다.
- 관측성 데이터채택률, 실패, 롤백 활동 및 디바이스별 상태를 포함합니다.
일반적인 요청은 예측 가능한 순서를 따릅니다. 파이프라인이 번들을 생성하거나 준비한 후, Capgo에 JSON 메타데이터를 전송하고 반환된 상태를 확인한 다음, 릴리스를 적절한 채널에 할당합니다. 이후 쿼리로 업데이트를 받은 디바이스를 확인할 수 있습니다.
핵심 아이디어: Capgo JSON을 단순한 데이터 형식이 아닌 릴리스 제어 계약으로 취급하세요. 모든 필드는 애플리케이션 업데이트의 게시, 대상 지정, 모니터링 또는 복구를 지원해야 합니다.
타입 지정 JSON의 장점
타입 지정 페이로드는 TypeScript 코드베이스의 모호성을 줄여줍니다. 버전 식별자는 문자열, 롤아웃 플래그는 Boolean, 디바이스 수는 숫자로 유지해야 합니다. 자동화를 연결하기 전에 요청과 응답에 대한 인터페이스를 정의하고, 필수 필드와 null 가능 값을 검증하세요.
함께 읽기: API와 TypeScript 사용법 자세히 보기.
모든 통합에서 이 세 가지 습관을 유지하세요:
- 상태 코드와 응답 본문을 함께 검사하세요. HTTP 성공만으로는 배포 완료를 설명하지 못할 수 있습니다.
- 반환된 식별자를 보존하세요. 특히 bundle, version, channel ID는 후속 호출에 필요합니다.
- 안전하게 로깅하세요, API 키와 민감한 기기 데이터는 제외됩니다.
다음 참조 섹션은 이 기반을 바탕으로 인증, 업로드 페이로드, 채널 스키마, 타겟팅 쿼리 및 오류 객체를 설명합니다. 최신 엔드포인트 이름과 필드 정의는 Capgo의 문서에서 확인하세요. capgo.app.
{\n“authorization”: “Bearer YOUR_CAPGO_API_KEY”,\n“contentType”: “application/json”,\n“accept”: “application/json”\n}
{ “success”: true, “bundleId”: “com.example.field-app”, “version”: “2.4.0”, “status”: “uploaded”, “bundleUuid”: “generated-bundle-identifier”, “createdAt”: “2026-01-15T10:30:00Z” }
{\n“defaultVersion”: “2.4.3”,\n“autoUpdate”: true,\n“rollbackProtection”: {\n“enabled”: true,\n“fallbackVersion”: “2.4.2”\n}\n}
{ “data”: [ { “timestamp”: “2026-02-04T09:00:00Z”, “installs”: 842, “rollbacks”: 3, “errors”: 11 }, { “timestamp”: “2026-02-04T10:00:00Z”, “installs”: 1276, “rollbacks”: 2, “errors”: 8 } ], “summary”: { “totalInstalls”: 2118, “totalRollbacks”: 5, “totalErrors”: 19 } }
{ “error”: { “code”: “INVALID_PARAMETER”, “message”: “‘version’ 필드가 필요합니다”, “field”: “version”, “details”: { “expected”: “string”, “received”: “null” } } }
{\n“version”: “2.4.0”,\n“checksum”: “sha256-value”,\n“encryption”: true,\n“externalUrl”: “"}https://storage.example/bundle.zip” }
