API 개요

설치

이 문서는 Capgo의 공개 API에 대한 것입니다. Capgo 클라우드의 API입니다. 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/

legacy __CAPGO_KEEP_0__ 키를 사용하는 경우 authorization API x-api-key 는 모든 키 유형,包括 보안 해시 키에 대한 권장 헤더입니다.

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

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

Device channel changes use the plugin API and have separate abuse-prevention limits that apply to every plan, including trials:

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

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

오류 설명 field는 오류가 발생한 이유를 설명합니다. data 성공적인 응답 예시: status __CAPGO_KEEP_0__ error __CAPGO_KEEP_1__

__CAPGO_KEEP_2__

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

예제 오류 응답:

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

단체 단체를 생성하고 관리하고 설정을 업데이트하고 단체 수준 구성으로 처리합니다.

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

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

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

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

최선의 방법 섹션오류 처리
오류 응답이 항상 확인되어 적절히 처리되어야 합니다. : 오류 처리는 항상 확인되어 적절히 처리되어야 합니다. (이 문구는 원본 문구와 동일합니다.): __CAPGO_KEEP_0__을 초과하는 속도 제한을 만나면 지수 백오프를 구현하세요.
캐싱: 적절한 경우 API 호출을 줄이기 위해 응답을 캐싱하세요.
버전 관리: API의 변경 사항을 통해 우리의 변경 로그를 관리하세요.

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