API 키 관리
API 키는 백엔드 서버나 자동화 스크립트가 EasterAd Core API를 호출할 때 사용하는 인증 자격 증명입니다.
1. API 키 발급 절차
섹션 제목: “1. API 키 발급 절차”대상 조직의 API 키 추가 권한과 부여할 역할이 필요합니다. 역할의 권한·유효기간은 권한 부여 기준을 충족해야 합니다.
- 콘솔 사이드바에서 조직 설정 → 멤버 관리로 이동합니다.
- 상단의 API 키 생성을 선택합니다.
- 보안 정책과 연동 목적에 맞춰 아래 항목을 입력합니다.
| 설정 항목 | 입력 규칙 및 설정 기준 |
|---|---|
| 역할 * | 이 키가 수행할 작업 권한을 선택합니다. 업무에 필요한 최소 권한을 가진 전용 역할(예: Campaign_Reader_Bot)을 별도로 생성하여 부여합니다. |
| 키 이름 * | 식별용 이름을 입력합니다(예: AWS_Prod_Billing_Sync_Bot). |
| 설명 | 사용 서버, 담당자 연락처, 연동 목적을 입력합니다. |
| IP 허용목록 | 호출을 허용할 고정 공인 IP 또는 CIDR 대역(예: 203.0.113.50 또는 198.51.100.0/24)을 입력합니다. 여러 주소는 IP 추가를 선택해 각각 입력합니다. 값을 비워두면 모든 IP에서 호출을 허용합니다. 운영 환경에서는 고정 공인 IP를 지정합니다. |
| 요청 제한 | 허용할 최대 요청 수와 시간 창(초)을 입력합니다. 기본 제안값은 10,000회 / 3,600초(1시간)입니다. |
| 만료일 | 자동 만료할 날짜와 시각을 지정합니다. 정기적인 키 갱신 주기에 맞춰 설정합니다. |
- 생성을 선택합니다. 생성 완료 창에서 아래 안내에 따라 전체 키를 복사합니다.
2. API 키 정책 수정과 교체
섹션 제목: “2. API 키 정책 수정과 교체”콘솔 사이드바의 조직 설정 → 멤버 관리에서 등록된 API 키 행의 작업 메뉴를 선택하여 관리합니다.
- 정책 수정: 키 이름, 설명, IP 허용목록, 요청 제한, 만료일을 변경합니다. 키 문자열은 유지됩니다.
- 키 교체:
- 교체를 선택하면 새 시크릿이 1회 발급되며, 기존 키는 즉시 폐기됩니다.
- 무중단 교체 방법: 운영 중인 서비스의 호출 중단을 방지하려면 새 API 키를 추가 발급하여 서버 환경 변수에 배포하고, 정상 동작을 확인한 뒤 기존 키를 삭제합니다.
- 키 삭제: 해당 API 키를 영구 폐기합니다. 삭제 즉시 해당 키를 사용한 모든 API 요청이 거부됩니다.
3. 핵심 보안 수칙
섹션 제목: “3. 핵심 보안 수칙”- API 키는 서버에서만 사용합니다.
- 키 유출이 의심되면 콘솔에서 해당 키를 즉시 교체하거나 삭제합니다.