API 개요

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

인증

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

예시:

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

API 키 가져오기 API 키를 Capgo 대시보드에서 생성하세요

The authorization header는 아직 API 키의 이전 버전을 위해 허용됩니다. x-api-key 속도 제한

속도 제한 제목

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

• __CAPGO_KEEP_0__
• 기업 계정에 대해 1분에 1000개의 요청

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

디바이스 채널 변경

디바이스 채널 변경은 플러그인 API을 사용하고 모든 계획(트라이얼 포함)에 적용되는 별도의 방지 제한을 가집니다.

• 디바이스는 각 채널 연산 (set, get, delete, 또는 list)에 대해 1초에 최대 5개의 요청을 할 수 있습니다. 이 제한은 앱, 디바이스 및 연산에 적용됩니다.
• 60초 이내에 동일한 디바이스를 동일한 채널에 설정하면 429 응답이 반환됩니다. 채널 Switching은 초당 제한이 리셋된 후 허용됩니다.
• 각 앱 및 IP 주소당 채널 요청 1000개에 대한 추가 제한이 적용됩니다.

이 제한은 계정 범위가 아닙니다. 채널 Switcher가 최근에 선택한 채널로 돌아갈 수 있다면 429 응답의 retryAfterSeconds 기간을 기다려서 다시 시도해 주세요.

응답 형식

모든 응답은 JSON 형식입니다. 성공적인 응답은 일반적으로 객체 또는 field 중 하나를 포함합니다. 오류 응답은 field와 오류 설명이 포함된 field를 포함합니다. data 객체 또는 field status field error field

예시 성공 응답:

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

예시 오류 응답:

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

사용 가능한 엔드포인트

조직 조직 만들기, 설정 업데이트 및 조직 수준 구성 관리

API 키 안전한 접근을 위한 Capgo API에 대한 API 키 생성, 목록 및 취소

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

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

채널 앱 업데이트 채널, 버전(번들), 업데이트 정책 관리

장치 앱이 실행되는 장치 추적 및 관리, 버전(번들) 및 채널 assignments 관리

패키지 앱 패키지를 업로드, 목록, 관리하는 것을 포함하여 패키지(버전) 관리

최선의 방법

1. 오류 처리: 오류 응답이 항상 확인되고 적절하게 처리되어야 함
2. 속도 제한: 속도 제한을 만나면 지수 백오프를 implement
3. 캐싱: 캐시 응답을 적절하게 사용하여 API 호출을 줄이기
4. 버전 관리: API 변경 사항을 변경 로그를 통해 추적

API 개요로 계속하기

__CAPGO_KEEP_0__을 사용 중이라면 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의 구현 세부 정보를 참조하십시오. 두 단계 인증 중국에서 __CAPGO_KEEP_0__ 사용 두 단계 인증 SSO (기업)