API 키 설정
API 키는 외부 시스템이 ABC User Feedback과 안전하게 연동할 수 있도록 하는 인증 수단입니다. 이 문서에서는 API 키 생성부터 관리, 보안 유지까지 화면 중심으로 설명합니다.
API 키 개요
API 키의 역할
API 키는 다음과 같은 목적으로 사용됩니다:
- 외부 시스템 인증: 웹사이트, 모바일 앱에서 피드백 전송
- 자동화 연동: 배치 작업, 스크립트를 통한 데이터 수집
- 서드파티 도구 연결: 분석 도구, 모니터링 시스템 연동
- 보안 제어: 프로젝트별 독립적인 접근 권한 관리
보안 특징
- 프로젝트별 독립성: 각 프로젝트마다 별도의 키 발급
- 상태 관리: Active/Inactive 상태로 즉시 제어 가능
API 키 생성
접근 방법
- 상단 메뉴에서 Settings 클릭
- 좌측 메뉴에서 API 키 관리 선택
키 생성 과정
1. 생성 버튼 클릭
API 키 관리 화면에서 우측 상단의 Create API Key 버튼을 클릭합니다.
2. 자동 생성 및 표시
버튼 클릭 즉시 새로운 API 키가 자동으로 생성되고 팝업으로 표시됩니다.
팝업 구성 요소:
- API 키 값: 전체 키 문자열 표시
- Copy 버튼: 클립보드로 즉시 복사
API 키 목록 관리
키 목록 화면 구성
생성된 API 키들은 테이블 형태로 관리됩니다.
테이블 컬럼 정보
| 컬럼 | 설명 | 표시 형태 |
|---|---|---|
| API 키 | 생성된 키 값 | AbcdEfgh... |
| Status | 현재 활성화 상태 | Active / Inactive |
| Created | 키 생성 일시 | 2024-03-15 14:30 |
| Actions | 관리 액션 버튼들 | 상태 변경, 삭제 버튼 |
키 식별 방법
전체 키 값을 다시 볼 수 없으므로 다음 방법으로 키를 구분합니다:
- 생성 시간: 언제 만들어진 키인지 확인
- 사용 목적 메모: 별도로 키의 용도를 기록해 두기
API 키 상태 관리
Active / Inactive 전환
각 API 키는 즉시 활성화/비활성화할 수 있습니다.
상태별 의미
| 상태 | 설명 | API 호출 결과 |
|---|---|---|
| Active | 실제 API 호출에 사용 가능 | 정상 처리 |
| Inactive | 호출 차단 상태 | 401 Unauthorized |
상태 변경 방법
- API 키 목록에서 Status 컬럼의 토글 스위치를 클릭합니다
- 상태가 즉시 변경되며 화면에 반영됩니다
- 해당 키를 사용하는 외부 시스템에서 즉시 영향을 받습니다
API 키 삭제
삭제 시점
다음과 같은 경우 API 키를 삭제해야 합니다:
- 키 노출: 실수로 키가 공개된 경우
- 프로젝트 종료: 해당 프로젝트 사용 종료
- 보안 정책: 정기적 키 교체 정책에 따라
- 미사용 키: 더 이상 사용하지 않는 키 정리
삭제 방법
1. 삭제 버튼 클릭
키 목록에서 삭제하려는 키의 Actions 컬럼에서 삭제 버튼을 클릭합니다.
2. 삭제 확인
확인 대화상자에서 삭제를 최종 승인합니다.
3. 삭제 완료
Delete 버튼 클릭 시 키가 즉시 삭제되며 목록에서 제거됩니다.
관련 문서
- API 연동 가이드 - API 키를 사용한 실제 연동 구현 방법
- 프로젝트 관리 - 프로젝트별 API 키 관리