사용 가이드
인증, 응답 형식, 공통 엔드포인트, 에러 코드입니다. 채널별 파라미터는 좌측 수집 채널에서 확인하세요.
인증
모든 요청에 발급받은 API 키를 헤더로 포함합니다. 키는 관리자에게 발급받으세요(없거나 비활성이면 401).
Authorization: Bearer YOUR_API_KEY
응답 형식
// 성공
{ "success": true, "data": { ... } }
// 실패
{ "success": false, "error": { "code": "invalid_params", "message": "..." } }
엔드포인트
GET/channels
호출 가능한 채널과 파라미터 정의를 반환합니다.
POST/collect
수집 요청 생성. 202로 request_id를 즉시 반환(수집은 백그라운드 진행).
| 필드 | 타입 | 필수 | 설명 |
|---|---|---|---|
| channel | string | 예 | 채널 코드 (좌측 수집 채널 참고) |
| params | object | 예 | 채널별 파라미터 |
| callback_url | URL | 아니오 | 완료 시 결과 요약 POST 받을 주소 |
| external_ref | string | 아니오 | 클라이언트 식별자(응답·콜백에 반환) |
| priority | int | 아니오 | 클수록 먼저 처리 |
// 202
{ "success":true, "data":{ "request_id":42, "status":"pending",
"status_url":"https://scraper.conbus.co.kr/api/v1/requests/42" } }
GET/requests/{request_id}
상태 조회. 완료 시 data.items에 결과 배열 포함. (본인 키로 만든 요청만 조회)
{ "success":true, "data":{ "status":"done", "result_count":30,
"items":[ { "post_id":"...", "title":"...", "author":"...", ... } ] } }
GET/requests
본인 키로 만든 최근 요청 목록(최대 50건).
에러 코드
| HTTP | code | 의미 |
|---|---|---|
| 401 | unauthorized | API 키 없음/유효하지 않음 |
| 403 | forbidden_channel | 허용되지 않은 채널 |
| 404 | unknown_channel / not_found | 없는 채널 / 없는 요청 |
| 422 | invalid_params | 필수 파라미터 누락/형식 오류 |
| 429 | (throttle) | 분당 요청 한도 초과 |