컨텐츠로 바로가기

API 개요

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

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

예시:

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

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

  • 표준 계정의 경우 1분당 100개의 요청이 허용됩니다.
  • 1000분 단위로 기업 계정에 대한 요청 제한

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

응답 형식

응답 형식

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

성공적인 응답 예시:

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

오류 응답 예시:

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

사용 가능한 엔드포인트

사용 가능한 엔드포인트
  1. 오류 처리: 항상 오류 응답을 확인하고 적절히 처리하세요
  2. 속도 제한: 속도 제한을 만나면 지연 백오프를 implement하세요
  3. 캐싱: 캐시 응답을 사용하여 API calls를 줄이세요
  4. 버전 관리: API의 변경 사항을 추적하기 위해 우리의 변경 로그를 사용하세요.