사용 가이드

인증, 응답 형식, 공통 엔드포인트, 에러 코드입니다. 채널별 파라미터는 좌측 수집 채널에서 확인하세요.

인증

모든 요청에 발급받은 API 키를 헤더로 포함합니다. 키는 관리자에게 발급받으세요(없거나 비활성이면 401).

Authorization: Bearer YOUR_API_KEY

X-API-Key: YOUR_API_KEY 헤더로 보내도 됩니다.

화이트리스트 IP — 키 없이 호출
관리자가 API 키에 허용 IP를 등록해 두면, 그 IP에서 오는 요청은 키(헤더) 없이도 해당 키로 인증됩니다(요청한 클라이언트의 실제 IP 기준).

// 성공
{ "success": true, "data": { ... } }

// 실패
{ "success": false, "error": { "code": "invalid_params", "message": "..." } }

GET/channels

호출 가능한 채널과 파라미터 정의를 반환합니다.

POST/collect

수집 요청 생성. 202로 request_id를 즉시 반환(수집은 백그라운드 진행).

// 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건).