내용으로 건너뛰기

API 개요

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

모든 API 엔드포인트는 인증이 필요합니다. 인증을 위해 API 키를 헤더에 추가하세요. x-api-key __CAPGO_KEEP_0__ setup 지침을 복사합니다. 설치 단계와 이 플러그인의 전체 마크다운 가이드가 포함됩니다.

예시:

터미널 창
curl -H "x-api-key: YOUR_API_KEY" https://api.capgo.app/organization/

The authorization legacy API 키를 위해 헤더는 여전히 지원되지만, API 키의 모든 유형,包括 보안 해시 키를 위한 헤더는 __CAPGO_KEEP_2__로 추천됩니다. x-api-key 속도 제한

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

  • 100
  • 1000 분당 기업 계정에 대한 요청 제한

429 (Too Many Requests) 응답을 받게 됩니다.

응답 형식

응답 형식

모든 응답은 JSON 형식입니다. 성공적인 응답은 일반적으로 data 객체 또는 status 필드 error 에 포함됩니다. 오류 응답은 오류 설명을 포함하는

필드

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

성공적인 응답 예시:

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

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

최선의 방법

최선의 방법
  1. 오류 처리: 오류 응답이 있는지 항상 확인하고 적절히 처리하세요
  2. 속도 제한: 속도 제한을 만나면 지연 백오프를 implement하세요
  3. 캐싱: 캐시 응답을 사용하여 API 호출을 줄이세요
  4. 버전 관리: API의 변경 사항을 추적하기 위해我们的 변경 로그를 사용하세요

Capacitor를 사용하는 경우 API 개요 __CAPGO_KEEP_0__을 사용하여 인증 및 계정 흐름을 계획하고 있습니다. __CAPGO_KEEP_0__을 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-social-login와 연결하세요. Capacitor를 사용하여 @capgo/capacitor-social-login의 구현 세부 사항을 참조하세요. Capacitor를 사용하여 @capgo/capacitor-passkey의 구현 세부 사항을 참조하세요. Capacitor를 사용하여 @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 (기업)에 대해