문서 목차
AkashiQ v0.1.0 · 연계
외부 Data API
API Key로 인증된 외부 시스템에 데이터셋을 공급하고 호출을 통제합니다
QUANTUM C&S
레이크하우스에 모은 데이터를 외부 시스템에 안전하게 공급하는 통로입니다. 협력사 BI, 분석 플랫폼, 다른 사내 시스템이 데이터를 가져갈 때 사용합니다.
관리 위치는 Data Hub → API Keys 이며, 데이터셋 등록 시 지정한 API slug가 공급 경로가 됩니다.
왜 별도 통로인가
외부에 데이터를 주려면 사용자 로그인과 다른 방식이 필요합니다.
- 사람이 아니라 시스템이 호출합니다.
- 누가 얼마나 어디서 호출했는지 기록해야 합니다.
- 문제가 생기면 즉시 차단할 수단이 필요합니다.
무인증으로 열어 두면 이 세 가지가 모두 불가능합니다.
키 발급
| 항목 | 설명 |
|---|---|
| 이름 | 키의 용도를 알 수 있는 이름 (예: 협력사 BI) |
| 소비자 유형 | 어떤 종류의 소비자인가 |
| 유효 기간 | 만료까지의 일수 |
| 분당 호출 한도 | 초과 시 차단 |
| 허용 IP | 특정 주소 · 대역에서만 허용 (10.0.0.0/8 형식) |
| 접근 범위(스코프) | 이 키로 접근할 수 있는 데이터셋 목록 |
⚠️ 주의
발급된 키는 발급 직후 한 번만 표시됩니다. 그 자리에서 복사해 안전한 곳에 보관하세요. 다시 확인할 수 없고, 잃어버리면 새로 발급해야 합니다.
접근 범위(스코프)
키마다 접근 가능한 데이터셋을 명시적으로 선택합니다. 스코프에 없는 데이터셋은 같은 키로 조회할 수 없습니다.
소비자별로 키를 나누고 스코프를 좁게 주는 것을 권장합니다. 키 하나에 전체 권한을 주면 회수 시 영향 범위가 커집니다.
호출 통제
| 통제 | 동작 |
|---|---|
| 인증 | 유효한 키가 없으면 거부 |
| 스코프 | 허용되지 않은 데이터셋 요청 거부 |
| 호출 한도 | 분당 한도 초과 시 거부 |
| IP 제한 | 허용 목록 밖에서 오면 거부 |
| 만료 | 유효 기간 경과 시 거부 |
| 폐기 | 폐기된 키는 즉시 거부 |
사용 통계
키를 선택하면 사용 현황을 확인합니다.
| 지표 | 의미 |
|---|---|
| 누적 호출 | 전체 호출 수 |
| 허용 | 기간 내 허용된 호출 수 |
| 거부 | 기간 내 거부된 호출 수 |
| 거부 사유 분포 | 어떤 이유로 거부됐는지 |
| 일별 추이 | 날짜별 호출 수 |
거부가 갑자기 늘었다면 원인을 구분해야 합니다. 한도 초과는 소비자 측 호출 패턴 문제이고, IP 거부는 네트워크 변경, 스코프 거부는 소비자가 권한 밖 데이터를 요청하고 있다는 신호입니다.
감사 기록
키별 호출 이력이 기록됩니다. 키 발급 · 수정 · 폐기도 감사 로그에 남습니다.
운영 권장 사항
- 소비자별로 키를 분리합니다. 공용 키는 회수와 추적을 어렵게 만듭니다.
- 유효 기간을 반드시 설정합니다. 무기한 키는 잊혀진 채 남습니다.
- 한도를 처음부터 설정합니다. 예상 호출량의 여유분 정도로 시작해 조정합니다.
- 허용 IP를 지정합니다. 폐쇄망이라도 내부 이동 경로를 좁힐 수 있습니다.
- 사용되지 않는 키는 폐기합니다. 통계에서 호출 0인 키를 정기적으로 정리합니다.
키가 노출됐을 때
- 해당 키를 즉시 폐기합니다.
- 사용 통계와 호출 이력으로 노출 기간의 접근 내역을 확인합니다.
- 새 키를 발급해 소비자에게 안전한 경로로 전달합니다.
- 필요하면 허용 IP를 더 좁힙니다.