API 개요

설치

This is the documentation of the public API of Capgo cloud. The API allows you to programmatically manage your Capgo resources, including organizations, devices, channels, and bundles. It’s designed to be RESTful and uses standard HTTP methods.

인증

All API endpoints require authentication. To authenticate your requests, add your API key in the x-api-key 예시:

터미널 창

curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

Get API key Generate your API key in the Capgo dashboard

The authorization header is still accepted for legacy API keys, but x-api-key __CAPGO_KEEP_0__는 모든 키 유형,包括 보안 해시 키를 위한 권장 헤더입니다.

속도 제한

API는 공정한 사용을 보장하기 위해 속도 제한을 구현합니다. 현재 제한은 다음과 같습니다.

표준 계정당 1분에 100건의 요청
기업 계정당 1분에 1000건의 요청

이 제한을 초과하면 429 (Too Many Requests) 응답을 받게 됩니다.

장치 채널 변경

장치 채널 변경은 플러그인 API을 사용하고 모든 계획, 포함하여 시험판에도 적용되는 악용 방지 제한을 별도로 가집니다.

장치당 1초에 각 채널 연산 (set, get, delete, 또는 list. 이 제한은 앱, 장치 및 작업에 적용됩니다.
같은 장치를 같은 채널로 60 초 이내에 여러 번 설정하면 429 오류가 반환됩니다. 1 초 제한이 초기화된 후 다른 채널로 Switching이 허용됩니다.
각 앱 및 IP 주소당 1분에 1000개의 채널 요청이 추가로 적용됩니다.

이 제한은 계정 범위가 아닙니다. 채널 Switcher가 최근에 선택한 채널로 돌아갈 수 있다면, 429 오류에서 지정된 지속 시간을 기다려야 합니다. retryAfterSeconds 응답 형식

응답 형식 섹션

예제 성공 응답: data ]}] } status 응답 형식은 JSON 형식입니다. 성공적인 응답은 객체 또는 필드를 포함합니다. 오류 응답은 오류가 발생한 이유에 대한 설명이 포함된 오류 필드를 포함합니다. error 응답 형식은 JSON 형식입니다. 성공적인 응답은 객체 또는 필드를 포함합니다. 오류 응답은 오류가 발생한 이유에 대한 설명이 포함된 오류 필드를 포함합니다.

응답 형식은 JSON 형식입니다. 성공적인 응답은 객체 또는 필드를 포함합니다. 오류 응답은 오류가 발생한 이유에 대한 설명이 포함된 오류 필드를 포함합니다.

{
  "status": "ok",
  "data": { ... }
}

예제 오류 응답:

{
  "error": "Invalid API key",
  "status": "KO"
}

사용 가능한 엔드포인트

조직 조직을 생성하고 관리하며 설정을 업데이트하고 조직 수준의 구성 요소를 처리합니다.

API 키 API 키를 생성하고 목록을 만들고 취소하여 Capgo API에 대한 안전한 접근을 보장합니다.

멤버 조직 멤버, 역할 및 권한을 관리합니다.

통계 앱 사용, 저장소 및 대역폭 소비량에 대한 자세한 분석에 접근하세요.

채널 Capgo 릴리스 채널 기능 이름. 페이지/영역: Capgo 솔루션 마케팅 페이지. 역할: 짧은 UI 레이블 또는 네비게이션 아이템. 보이는 곳: 페이지 solutions/white-label.astro. 메시지 키 `solutions_white_label_visual_cell2_value` (솔루션 화이트 레이블 시각 셀2 값).

앱 업데이트 채널, 버전, 및 업데이트 정책을 제어하세요. 장치

앱을 실행하는 장치를 추적하고 관리하세요. 이에는 버전 및 채널 assignments 포함됩니다. 버전

앱 버전을 관리하세요. 이에는 업로드, 목록, 및 버전 관리 포함됩니다.

최선의 방법 섹션오류 처리
오류 응답이 항상 발생할 수 있으므로 적절하게 처리하세요.: __CAPGO_KEEP_0__을 초과하는 경우 지연 시간을 사용하세요.
캐싱: API 호출을 줄이기 위해 응답을 캐싱하세요.
버전 관리: API의 변경 사항을 변경 로그를 통해 추적하세요.

API 개요에서 계속

__CAPGO_KEEP_0__ 개요에서 계속하기 API을 사용하는 경우 __CAPGO_KEEP_0__ 개요 capgo과 capacitor-social-login을 연결하세요. capgo/capacitor-social-login에서 구현 세부 정보를 참조하세요. capgo/capacitor-passkey capgo/capacitor-passkey 구현 세부 사항 capgo/capacitor-native-biometric capgo/capacitor-native-biometric 구현 세부 사항 두 단계 인증 두 단계 인증 구현 세부 사항 및 SSO (기업) SSO (기업) 구현 세부 사항.