ko
시작하기인증

인증

요청은 모든 호출에 베어러 토큰으로 전송되는 시크릿 API 키로 인증됩니다.

API 키를 베어러 토큰으로 포함합니다. 샌드박스 키는 chsk_test_ 프리픽스를, 프로덕션 키는 chsk_live_ 프리픽스를 사용합니다.

curl "https://api.crisphive.com/v1/customers" \
  -H "Authorization: Bearer chsk_test_4eC8xQ9mZ2pL7Ka0rT"

키 관리

설정 → 개발자에서 키를 생성합니다. 키에 이름을 지정하고, 생성 시 한 번만 표시되는 값을 복사하고, 원한다면 특정 권한 스코프로 제한하고, 언제든지 폐기할 수 있습니다.

키는 절대 생성자보다 더 많은 권한을 가질 수 없습니다. 새 키의 스코프는 스코프 목록을 비워 두더라도 키를 생성하는 사용자의 권한을 상한으로 합니다. 생성 시 그 이상을 요청하면 403 API_KEY_SCOPE_NOT_GRANTED로 실패하므로 — 전체 권한이 필요하다면 전체 접근 권한을 가진 사용자(또는 소유자)가 키를 생성하도록 하세요.

만료

API 키는 만료됩니다. 키의 유효 기간은 생성할 때 선택하며 — 기본 30일, 1일부터 365일까지 — 해당 키가 존재하는 동안 고정됩니다. 유효 기간은 나중에 연장할 수 없으므로(키 이름을 변경해도 절대 바뀌지 않습니다) 키의 expires_at은 절대 변경되지 않습니다. 이 값은 키 API가 반환하고 대시보드에도 표시되므로, 값을 읽고 교체 일정을 계획하세요.

Crisphive는 키가 만료되기 7일 전과 만료된 후에 비즈니스의 소유자와 관리자에게 이메일도 발송합니다. 이메일에만 의존하지 마세요 — 이메일은 비즈니스로 발송되며 반드시 여러분에게 오는 것은 아니므로, 계속 expires_at을 읽고 직접 교체 일정을 계획하세요.

키 갱신하기

갱신하려면 새 키를 만드세요 — 로테이션 엔드포인트는 없습니다. 비즈니스는 환경당 최대 50개의 활성 키를 보유할 수 있으므로, 교체 과정에 특별한 장치가 필요 없고 다운타임도 없습니다:

1
두 번째 키 생성

대시보드에서 교체 키를 생성하세요.

2
배포

새 키를 연동에 배포하세요.

3
트래픽 확인

새 키로 트래픽이 흐르는지 확인하세요(last_used_at 또는 Developers → Logs).

4
기존 키 폐기

대시보드에서 기존 키를 폐기하세요.

AWS가 액세스 키에 대해 문서화한 것과 동일한 2-키 절차입니다. 키는 하드코딩하지 말고 설정에서 불러오세요. 그러면 2단계가 릴리스가 아니라 설정 변경으로 끝납니다. 키가 유출된 경우에는 순서를 반대로 하세요 — 먼저 폐기한 다음 교체 키를 생성하세요. 유출된 키를 살려 두는 것보다 몇 번의 호출 실패가 낫습니다. 키 관리는 대시보드 전용입니다 — 키를 생성하거나 폐기하는 공개 API는 없습니다.

유효 기간이 지난 키는 error_code: "API_KEY_EXPIRED"와 함께 401을 반환합니다 — API_KEY_INVALID(폐기, 삭제 또는 잘못된 값)와 의도적으로 구분되므로, 알림 시스템에서 갱신 누락과 폐기를 구별할 수 있습니다.

다른 비즈니스를 대신해 접근하기

API 키는 자신의 비즈니스를 인증합니다. 다른 Crisphive 비즈니스가 연결하는 제품을 만들고 있나요? 대신 OAuth 2.1을 사용하세요. 각 비즈니스 소유자가 동의 화면에서 앱을 승인하므로 키가 공유되는 일이 없습니다.