diff --git a/README.md b/README.md index 6215db6..3be57ce 100644 --- a/README.md +++ b/README.md @@ -148,6 +148,99 @@ docker-compose logs -f | `MATTERMOST_URL` | Mattermost 서버 URL | ❌ | | `NOTION_API_SECRET` | Notion API 시크릿 | ❌ | +## 🔑 API 키 발급 가이드 + +### 1. 공공데이터포털 API 키 (DATA_API_SERVICE_KEY, SERVICE_KEY) + +기상청 API, 대기질 API 등 공공데이터 사용에 필요합니다. + +1. [공공데이터포털](https://data.go.kr) 접속 및 회원가입 +2. 로그인 후 필요한 API 검색: + - **기상청_단기예보 조회서비스**: 초단기/단기 예보 + - **기상청_중기예보 조회서비스**: 중기 예보 + - **기상청_지상(종관, ASOS) 일자료 조회서비스**: ASOS 데이터 + - **한국환경공단_에어코리아_대기오염정보**: 대기질 정보 +3. 각 API의 "활용신청" 클릭 +4. 신청 승인 후 마이페이지 → 인증키 발급현황에서 **일반 인코딩 키** 복사 +5. `.env` 파일의 `DATA_API_SERVICE_KEY` 및 `SERVICE_KEY`에 동일한 키 입력 + +### 2. Google Analytics 4 (GA4_*) + +웹사이트 방문자 데이터 수집에 필요합니다. + +#### GA4 Property ID 확인 +1. [Google Analytics](https://analytics.google.com) 접속 +2. 관리(⚙️) → 속성 설정 → **속성 ID** 확인 +3. `.env` 파일의 `GA4_PROPERTY_ID`에 입력 + +#### 서비스 계정 생성 (API 접근용) +1. [Google Cloud Console](https://console.cloud.google.com) 접속 +2. 새 프로젝트 생성 또는 기존 프로젝트 선택 +3. **API 및 서비스** → **라이브러리** → "Google Analytics Data API" 검색 후 **사용 설정** +4. **API 및 서비스** → **사용자 인증 정보** → **+ 사용자 인증 정보 만들기** → **서비스 계정** +5. 서비스 계정 생성 후 **키** 탭 → **키 추가** → **새 키 만들기** → JSON 선택 +6. 다운로드된 JSON 파일을 `conf/service-account-credentials.json`으로 저장 +7. `.env` 파일의 `GA4_SERVICE_ACCOUNT_FILE`에 경로 입력 + +#### GA4에 서비스 계정 권한 부여 +1. Google Analytics → 관리(⚙️) → 속성 액세스 관리 +2. **+** 클릭 → **사용자 추가** +3. 서비스 계정 이메일 (예: `xxx@project-id.iam.gserviceaccount.com`) 입력 +4. **뷰어** 권한 부여 후 저장 + +### 3. Mattermost (MATTERMOST_*) + +Mattermost 알림 발송에 필요합니다. + +#### Bot 토큰 방식 (권장) +1. Mattermost 서버 → **통합** → **봇 계정** +2. **봇 계정 추가** 클릭 +3. 봇 이름, 설명 입력 후 생성 +4. 생성된 **액세스 토큰**을 `MATTERMOST_TOKEN`에 입력 +5. 봇을 사용할 채널에 봇 추가 +6. 채널 설정 → URL에서 채널 ID 확인 또는 API로 조회 +7. `MATTERMOST_CHANNEL_ID`에 채널 ID 입력 + +#### 웹훅 방식 (대안) +1. Mattermost 서버 → **통합** → **수신 웹훅** +2. **수신 웹훅 추가** 클릭 +3. 채널 선택 후 생성 +4. 생성된 웹훅 URL을 `MATTERMOST_WEBHOOK_URL`에 입력 + +### 4. Telegram Bot (TELEGRAM_*) + +Telegram 알림 발송에 필요합니다. + +1. Telegram에서 [@BotFather](https://t.me/BotFather) 검색 +2. `/newbot` 명령어 입력 +3. 봇 이름과 사용자명 입력 +4. 발급된 **HTTP API 토큰**을 `TELEGRAM_BOT_TOKEN`에 입력 +5. 봇과 대화 시작 (또는 그룹에 봇 추가) +6. `https://api.telegram.org/bot/getUpdates` 접속 +7. 응답에서 `chat.id` 값을 `TELEGRAM_CHAT_ID`에 입력 + +### 5. Notion API (NOTION_*) + +Notion 웹훅 처리에 필요합니다. + +1. [Notion Developers](https://developers.notion.com) 접속 +2. **+ New integration** 클릭 +3. 이름 입력, 워크스페이스 선택 후 생성 +4. **Internal Integration Secret**을 `NOTION_API_SECRET`에 입력 +5. Notion에서 연동할 페이지/DB 열기 +6. **···** → **커넥션** → 생성한 통합 추가 + +### 6. Synology Chat (SYNOLOGY_*) + +Synology Chat 알림 발송에 필요합니다. + +1. Synology Chat 앱 실행 +2. 채널 설정 → **통합** → **봇** +3. **+ 추가** → **수신 웹훅** 선택 +4. 봇 이름 입력 후 생성 +5. 생성된 **웹훅 URL**을 `SYNOLOGY_CHAT_URL`에 입력 +6. URL에 포함된 토큰을 `SYNOLOGY_CHAT_TOKEN`에 입력 + ## 🔧 개발 ### 코드 스타일