본문으로 건너뛰기

API 키 ​

API 키는 Open API를 호출할 때 쓰는 인증 수단이에요. 키는 스페이스 단위로 발급되고, 그 스페이스의 데이터에만 닿아요.

키는 chp_로 시작하는 문자열이고, 모든 요청의 Authorization: Bearer 헤더에 넣어 보내요.

키 사용
bash
curl https://api.cherpa.me/v1/content/blog/entries \
  -H "Authorization: Bearer chp_a1b2c3d4e5f6..."

키 발급 ​

콘솔 설정 → API 키 관리에서 발급해요.

  1. + API 키 발급을 눌러요.
  2. 키 이름을 정해요 (예: 프로덕션 웹). 나중에 어디에 쓰는 키인지 알아볼 수 있게요.
  3. 권한을 골라요. 아래 권한 표를 참고하세요.
  4. 발급을 누르면 키 원문이 나와요. 복사해서 안전한 곳에 보관하세요.

키 원문은 발급 직후 한 번만 볼 수 있어요

창을 닫으면 다시 확인할 수 없어요. 잃어버리면 키를 삭제하고 새로 발급해야 해요. 목록에는 키 앞부분(chp_a1b2c3d4)만 표시돼요.

발급된 키
chp_a1b2c3d4e5f6...
목록에 보이는 키
chp_a1b2c3d4

권한 ​

키마다 쓸 수 있는 API를 정해요. 쓰는 곳에 필요한 만큼만 주는 게 안전해요.

권한인바운드 등록아웃바운드 등록콘텐츠 조회
full 전체 접근✓✓✓
content 콘텐츠 읽기––✓
inquiry 문의 접수✓––

허용되지 않은 API를 호출하면 403이에요.

쓰는 곳권장 권한
웹사이트 문의 폼 (브라우저에서 직접 호출)inquiry
웹사이트에 콘텐츠 표시content
서버·스크립트에서 아웃바운드 등록full
권한 없는 호출 · 403
json
{
  "code": 7,
  "message": "이 API 키에는 해당 권한이 없어요",
  "detail": "이 API 키에는 해당 권한이 없어요"
}

키 보관과 교체 ​

  • full 키는 서버에만 두세요. 브라우저 번들·앱 바이너리·공개 저장소에 넣으면 누구나 볼 수 있어요.
  • 브라우저에서 직접 호출해야 하면 inquiry 또는 content 권한 키를 쓰세요. 노출돼도 그 범위 밖의 일은 할 수 없어요.
  • 환경(개발·프로덕션)과 용도별로 키를 따로 발급하면, 하나가 노출돼도 그 키만 교체하면 돼요.
  • 키가 노출됐다면 API 키 관리에서 삭제하세요. 삭제 즉시 그 키를 쓰는 요청은 401로 거부돼요. 새 키를 발급해 교체하면 돼요.

목록의 마지막 사용 시각으로 쓰이지 않는 키를 찾아 정리할 수 있어요 (5분 간격으로 갱신).

삭제된 키로 호출 · 401
json
{
  "code": 16,
  "message": "유효하지 않은 API 키예요",
  "detail": "유효하지 않은 API 키예요"
}