API 개요
뚜봇 API를 사용하면 외부 애플리케이션에서 봇 기능을 연동할 수 있습니다.
API는 현재 베타 버전입니다. 일부 기능이 변경될 수 있습니다.
기본 정보
Base URL
https://chzzk-bot.ddutto.com/api/v1
요청 형식
- 모든 요청은 HTTPS를 사용합니다.
- 인증이 필요한 요청은
Authorization헤더에 API 키를 포함해야 합니다.
Authorization: DDUBOT_API <api_key>
응답 형식
모든 응답은 JSON 형식으로 반환됩니다.
성공 응답 예시:
{
"success": true,
"data": [...]
}
오류 응답 예시:
{
"success": false,
"error": "오류 메시지"
}
사용 가능한 API
| 엔드포인트 | 메서드 | 설명 | 필요 권한 |
|---|---|---|---|
/roulette | GET | 룰렛 목록 조회 | read.roulette |
/roulette/logs | GET | 룰렛 로그 조회 | read.roulette |
/song-requests | GET | 신청곡 대기열 조회 | read.song-request |
/karaoke | GET | 노래방 대기열/완료 목록 조회 | read.karaoke |
/user_info | GET | 시청자 정보 조회 | read.viewer_info |
Rate Limiting
API 호출은 다음 제한이 적용됩니다:
- 분당 15회 요청 제한
- 제한 초과 시
429 Too Many Requests응답 반환
응답 헤더에서 Rate Limit 정보를 확인할 수 있습니다:
| 헤더 | 설명 |
|---|---|
X-RateLimit-Limit | 분당 최대 요청 수 |
X-RateLimit-Remaining | 남은 요청 수 |
X-RateLimit-Reset | 제한 초기화 시간 (Unix timestamp) |
Rate Limit을 초과하면 일정 시간 동안 API 호출이 차단됩니다.
다음 단계
API를 사용하려면 먼저 인증 설정이 필요합니다.