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.

인증

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

터미널 창

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

API 키를 __CAPGO_KEEP_1__ 대시보드에서 생성하세요. Capgo 대시보드에서 API 키를 생성하세요.

The authorization header는 API 키의 전통적인 헤더로 아직도 지원되지만 x-api-key __CAPGO_KEEP_0__ 키의 모든 유형, 보안 해시 키 포함하여 모든 키 유형의 추천 헤더입니다.

요청 제한

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

• 표준 계정의 경우 1분당 100개의 요청
• 기업 계정의 경우 1분당 1000개의 요청

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

응답 형식

모든 응답은 JSON 형식입니다. 성공적인 응답은 일반적으로 객체 또는 data object or a status __CAPGO_KEEP_0__ 키 error 에러 응답은 오류가 발생한

예제 성공 응답:

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

예제 에러 응답:

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

사용 가능한 엔드포인트

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

API 키 API 키를 생성하고 목록을 조회하고 Capgo API에 대한 안전한 접근을 위해 API 키를 취소합니다.

멤버 회원 관리, 역할, 및 권한 관리

통계 앱 사용, 저장소, 및 대역폭 소비량에 대한 세부 통계 접근

채널 앱 업데이트 채널, 버전, 및 업데이트 정책 관리

디바이스 앱이 실행 중인 디바이스 추적 및 관리, 버전 및 채널 assignments 포함

버전드 앱 버전 관리, 업로드, 목록, 및 버전 관리

최선의 방법

1. 에러 처리에러 응답을 항상 확인하고 적절히 처리하십시오
2. 제한 속도: 제한 속도에 부딪히면 지수 백오프를 구현하십시오
3. 캐싱: 캐싱을 사용하여 API 호출을 최소화하십시오
4. 버전 관리: API 변경 사항을 변경 로그를 통해 추적하십시오

API 개요에서 계속

__CAPGO_KEEP_0__를 사용 중이라면 API 개요 인증 및 계정 흐름을 계획하고 연결하려면 @capgo/capacitor-social-login 인증 구현 세부 정보는 @capgo/capacitor-social-login에서 확인할 수 있습니다. @capgo/capacitor-passkey 인증 구현 세부 정보는 @capgo/capacitor-passkey에서 확인할 수 있습니다. @capgo/capacitor-native-biometric 인증 구현 세부 정보는 @capgo/capacitor-native-biometric에서 확인할 수 있습니다. 두 단계 인증 두 단계 인증 구현 세부 정보는 두 단계 인증에서 확인할 수 있습니다. SSO (기업) SSO (기업) 구현 세부 정보는 SSO (기업)에서 확인할 수 있습니다.