메인 콘텐츠로 건너뛰기

CaseBender 엔드포인트

OpenAPI 사양 파일 보기

인증

모든 API 엔드포인트는 API 키를 사용한 인증이 필요합니다. 다음 방법 중 하나를 사용하여 모든 요청에 API 키를 포함하세요.

권장: Bearer 토큰

Authorization 헤더에 API 키를 Bearer 토큰으로 포함합니다.

대안: X-Api-Key 헤더

X-Api-Key 헤더를 사용할 수도 있습니다.
중요: API 키는 CaseBender 인스턴스에 대한 액세스 권한을 부여합니다. 안전하게 보관하고 절대로 공개적으로 공유하지 마세요.

API 키 생성

API 키를 생성하려면:
  1. CaseBender 인스턴스에 로그인합니다
  2. 계정API 키로 이동합니다
  3. API 키 생성을 클릭합니다
  4. 키의 이름, 설명, 등급(tier), 범위(scope)를 구성합니다
  5. 키를 즉시 저장하세요 — 키는 한 번만 표시되며 이후에는 다시 확인할 수 없습니다
API 키를 생성하면 다음과 같은 단일 키를 받게 됩니다.

API 키 사용

모든 API 요청에 API 키를 포함합니다.

cURL 사용

Python 사용 (requests 라이브러리)

JavaScript/Node.js 사용 (fetch)

API 키 등급

API 키에는 속도 제한을 결정하는 등급이 할당됩니다.
등급요청/분요청/시간버스트 허용량
Basic601,00010
Standard30010,00050
Professional1,00050,000100
Enterprise5,000200,000500
Unlimited무제한무제한무제한

API 키 범위

API 키를 생성할 때 특정 작업으로 액세스를 제한할 수 있습니다.
  • alerts:read - 알림 읽기
  • alerts:write - 알림 생성 및 업데이트
  • cases:read - 케이스 읽기
  • cases:write - 케이스 생성 및 업데이트
  • observables:read - 관찰 가능 항목 읽기
  • observables:write - 관찰 가능 항목 생성 및 업데이트
  • users:read - 사용자 정보 읽기
  • admin:* - 관리 작업

일반적인 인증 오류

  • 401 Unauthorized:
    • Authorization 헤더 누락
    • 잘못되었거나 만료된 API 키
    • API 키가 취소되었거나 정지됨
  • 403 Forbidden:
    • API 키에 해당 작업에 필요한 범위가 없음
    • TLP/PAP 액세스 제한
  • 429 Too Many Requests:
    • 등급의 속도 제한 초과

보안 모범 사례

  • API 키를 공유하지 마세요 — 비밀번호처럼 취급하세요
  • API 키를 정기적으로 교체하세요 — 오래된 키를 취소하고 주기적으로 새 키를 생성하세요
  • 애플리케이션마다 다른 키를 사용하세요 — 애플리케이션별로 액세스를 취소할 수 있습니다
  • 만료 날짜를 설정하세요 — 가능한 경우 API 키가 자동으로 만료되도록 구성하세요
  • 필요한 최소 범위만 사용하세요 — 애플리케이션에 필요한 권한만 부여하세요

레거시 인증 (지원 중단)

레거시 x-api-keyx-api-secret 헤더는 하위 호환성을 위해 계속 지원되지만 더 이상 사용되지 않습니다. Bearer 토큰 인증으로 마이그레이션하세요.