콘텐츠로 건너뛰기

API 개요

이것은 Capgo cloud의 공개 API 문서입니다. API를 사용하면 조직, 기기, 채널 및 번들을 포함한 Capgo 리소스를 프로그래밍 방식으로 관리할 수 있습니다. RESTful로 설계되었으며 표준 HTTP 메서드를 사용합니다.

모든 API 엔드포인트는 인증이 필요합니다. 요청을 인증하려면 authorization 헤더에 API 키를 추가하세요.

예시:

Terminal window
curl -H "authorization: your-api-key" https://api.capgo.app/organization/

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

  • 표준 계정의 경우 분당 100개 요청
  • 엔터프라이즈 계정의 경우 분당 1000개 요청

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

모든 응답은 JSON 형식입니다. 성공 응답에는 일반적으로 data 객체 또는 status 필드가 포함됩니다. 오류 응답에는 무엇이 잘못되었는지에 대한 설명이 포함된 error 필드가 포함됩니다.

성공 응답 예시:

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

오류 응답 예시:

{
"error": "Invalid API key",
"status": "KO"
}
  1. 오류 처리: 항상 오류 응답을 확인하고 적절하게 처리하세요
  2. 속도 제한: 속도 제한에 도달할 때 지수 백오프를 구현하세요
  3. 캐싱: API 호출을 줄이기 위해 적절한 경우 응답을 캐시하세요
  4. 버전 관리: 변경 로그를 통해 API 변경 사항을 추적하세요