API 개요

설치 단계와 이 플러그인의 전체 마크다운 가이드를 포함한 설정 명령어를 복사하세요.

API의 Capgo 클라우드의 공개 API의 문서입니다. API는 프로그램적으로 Capgo 리소스를 관리할 수 있도록 해줍니다. 이는 조직, 장치, 채널 및 패키지를 포함합니다. RESTful로 설계되어 표준 HTTP 메서드를 사용합니다.

인증

모든 API 엔드포인트는 인증이 필요합니다. 인증을 위해 요청을 인증하려면 API 키를 헤더에 추가하세요. x-api-key 헤더.

예시:

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

API 키 가져오기 API 키를 Capgo 대시보드에서 생성하세요.

The authorization 헤더는 전통적인 API 키에만 허용되지만, x-api-key 모든 키 유형(보안 해시 키 포함)에서 권장되는 헤더입니다.

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

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

기기 채널 변경은 플러그인 API을 사용하고 모든 계획(기본, 기업 포함)에 적용되는 악용 방지 제한이 있습니다.

기기당 1초에 5건의 요청이 각 채널 연산(, , 또는 )에 대해 허용됩니다. 이 제한은 앱, 기기 및 연산에 적용됩니다.set, get, delete60초 이내에 동일한 기기를 동일한 채널에 설정하면 429 응답이 반환됩니다. 채널을 변경하는 것은 초당 제한이 초기화된 후 허용됩니다. list각 앱 및 IP 주소당 1분에 1000건의 채널 요청이 추가로 허용됩니다.
__CAPGO_KEEP_0__
__CAPGO_KEEP_0__

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

성공 응답 예시: data 클립보드 복사 status 오류 응답 예시: error 클립보드 복사

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__

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

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

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

멤버 단체 멤버, 역할 및 권한을 관리합니다.

통계 앱 사용, 저장소 및 대역폭 소비에 대한 세부적인 분석 액세스

채널 앱 업데이트 채널, 버전(번들), 및 업데이트 정책을 제어합니다.

기기 앱이 실행되는 기기들을 추적하고 관리하세요. 버전 및 채널 assignments 포함

배포 앱 배포를 관리하세요. 업로드, 목록, 배포(버전) 관리 포함

이 기능을 사용 중이라면 API 개요 __CAPGO_KEEP_0__을 사용하여 인증 및 계정 흐름을 계획하고, __CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-login과 연결하세요 자세한 구현 정보는 @capgo/capacitor-social-login에서 확인할 수 있습니다. 자세한 구현 정보는 @capgo/capacitor-passkey에서 확인할 수 있습니다. 자세한 구현 정보는 @capgo/capacitor-native-biometric에서 확인할 수 있습니다. for the implementation detail in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric @capgo/capacitor-native-biometric 구현 세부 사항에 대해 두 단계 인증 @__CAPGO_KEEP_0__와 두 단계 인증, 그리고 SSO (기업) @__CAPGO_KEEP_0__의 SSO (기업) 구현 세부 사항에 대해