API 개요

설치

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

인증

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/

예시: authorization API 키를 헤더에 추가하세요. x-api-key __CAPGO_KEEP_0__는 모든 키 유형, 포함하여 보안 해시 키에 대한 권장 헤더입니다.

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

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

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

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

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

오류 설명 data 성공적인 응답 예시: status __CAPGO_KEEP_0__ error __CAPGO_KEEP_0__

__CAPGO_KEEP_0__

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

예제 오류 응답:

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

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

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

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

통계 앱 사용량, 저장소, 대역폭 소비량에 대한 자세한 분석 액세스

채널 채널

__CAPGO_KEEP_0__ 개요에서 계속하기 API를 사용하는 경우 __CAPGO_KEEP_0__ @capgo/capacitor-social-login capgo/capacitor-social-login @capgo/capacitor-passkey for the implementation detail in @capgo/capacitor-passkey, @capgo/capacitor-native-biometric for the implementation detail in @capgo/capacitor-native-biometric, 두 단계 인증 두 단계 인증 및 SSO (기업) SSO (기업) 구현 세부 사항