콘텐츠로 이동

인증과 API 키

Public API는 spk_ 접두사의 Bearer API 키를 사용합니다.

Authorization: Bearer spk_...

각 키는 하나의 브랜드에 귀속됩니다. /v1/brand/* 요청의 브랜드는 키에서 결정되며, 다른 브랜드를 요청 본문으로 선택할 수 없습니다.

API 키 발급은 브랜드 소유자만 할 수 있습니다.

엔드포인트에 따라 다음과 같은 권한이 검사됩니다.

  • brands:read, brands:write
  • connections:read
  • publishing:read, publishing:write
  • comments:read, comments:write, comments:moderate
  • analytics:read
  • webhooks:read, webhooks:write

권한이 부족하면 403 insufficient_scope가 반환됩니다.

  • /
  • /v1/health
  • /v1/docs
  • /v1/openapi.json

Free 브랜드는 활성 API 키 1개와 UTC 기준 월 1,000회의 계산 대상 API 요청을 사용할 수 있습니다. Growth는 여러 활성 키와 공정 사용 정책을 적용합니다.

유효한 인증 이후 발생한 성공·실패 요청은 모두 Free 할당량에 포함될 수 있습니다. 상태 확인, API 문서, OpenAPI, 유효하지 않은 키 요청은 계산 대상에서 제외됩니다.

  • 키를 환경 변수나 비밀 관리 서비스에 저장합니다.
  • 브라우저에 배포되는 코드에 키를 넣지 않습니다.
  • 로그에서는 전체 키를 출력하지 않습니다.
  • 사용하지 않는 키는 비활성화하고 새 키로 교체합니다.
  • 자동화별로 필요한 키를 분리해 사용 이력을 구분합니다.