API 개요

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

인증

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

터미널 창

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

__CAPGO_KEEP_1__ 대시보드에서 API 키를 생성하세요. Generate your API key in the Capgo dashboard

The authorization header는 API 키의 레거시 지원을 위해 아직도 허용되지만, 모든 키 유형(보안 해시 키 포함)에서 권장되는 헤더입니다. x-api-key Rate Limiting

“Rate Limiting”이라는 제목의 섹션

The API implements rate limiting to ensure fair usage. Current limits are:

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

“Response Format”이라는 제목의 섹션

모든 응답은 JSON 형식입니다. 성공적인 응답은 보통 __CAPGO_KEEP_0__를 포함합니다.

__CAPGO_KEEP_0__는 __CAPGO_KEEP_0__를 포함합니다. data __CAPGO_KEEP_0__ 키 status 필드. 오류 응답은 잘못된 것을 설명하는 error 필드가 포함됩니다.

예제 성공 응답:

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

예제 오류 응답:

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

사용 가능한 엔드포인트

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

API 키 Generate, list, and revoke API keys for secure access to the Capgo API

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

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

채널 앱 업데이트 채널, 버전, 및 업데이트 정책을 관리하세요.

디바이스 앱이 실행 중인 디바이스를 추적 및 관리하세요. 버전 및 채널 assignments 포함

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

최선의 방법

1. 오류 처리: 항상 오류 응답을 확인하고 적절히 처리하십시오
2. 요청 제한: 요청 제한을 만나면 지수 백오프를 implement 하십시오
3. 캐싱: 캐싱을 사용하여 API 호출을 줄이십시오
4. 버전 관리: API의 변경 사항을 changelog를 통해 추적하십시오

Keep going from API Overview

Capgo Overview로 계속 진행하십시오 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 (기업)의 구현 세부 정보를 참조하세요.