Caret는 API 키를 사용하여 요청을 인증합니다. [개발자] 페이지에서 키를 생성하고 관리할 수 있습니다.
API 키 생성
설정 접속
Caret 워크스페이스의 개발자 섹션으로 이동합니다.
키 생성
새 API 키 생성을 클릭하고 용도를 파악하기 쉬운 이름을 입력합니다.
권한 할당
키에 부여할 특정 권한 범위를 선택합니다. 최소 권한 원칙에 따라 필요한 권한만
부여하는 것을 권장합니다.
안전한 보관
생성된 키를 즉시 복사하여 안전한 곳에 보관하세요. 보안을 위해 다시 표시되지
않습니다.
API 키는 강력한 접근 권한을 가집니다. GitHub와 같은 공개 저장소나 클라이언트
측 코드에 키가 노출되지 않도록 주의하세요.
사용 방법
모든 API 요청의 X-API-Key HTTP 헤더에 API 키를 포함해야 합니다.
curl -X GET "https://api.caret.so/v1/me" \
-H "X-API-Key: your_api_key_here"
권한 범위 (Scopes)
각 키에 대해 다음과 같은 권한을 설정할 수 있습니다:
| 범위 | 설명 |
|---|
users | 사용자 정보 조회 및 초대 관리 |
notes | 미팅 기록 및 요약본 읽기/쓰기 |
folders | 워크스페이스 폴더 생성, 수정, 삭제 |
templates | 미팅 템플릿 및 AI 설정 관리 |
권장 보안 수칙
- 용도별 키 분리: 서비스나 환경(개발, 운영 등)마다 별도의 키를 사용하세요.
- 정기적 교체: 유출 피해를 최소화하기 위해 주기적으로 키를 재생성하세요.
- 환경 변수 활용: 소스 코드에 키를 직접 입력하지 말고 환경 변수로 관리하세요.
오류 해결
- 401 Unauthorized: 키가 누락되었거나 유효하지 않습니다. 헤더 형식을 확인하세요.
- 403 Forbidden: 키는 유효하지만 요청한 엔드포인트에 대한 권한이 없습니다.
