크롤링 봇 파라미터 메타 조회 V4

GET www.hashscraper.com/v4/api/schedules/{schedule_id}/param_info

특정 크롤링 봇의 입력 파라미터 정의와 허용값 목록을 조회합니다.

collect 호출 전에 어떤 파라미터를 사용으로 지정해 두었는지, 각 파라미터가 어떤 값을 허용하는지 확인하는 용도입니다.

param_info의 각 항목에는 허용값 목록(options)이 함께 노출되어, 별도 호출 없이 어떤 값을 보낼 수 있는지 바로 확인할 수 있습니다.

요청 파라미터

Authorization: Header

해시스크래퍼 API 키. Bearer <api_key> 형식으로 전달합니다.

예시 Bearer YOUR_API_KEY
schedule_id: String (path)

조회할 크롤링 봇의 ID. URL 경로의 {schedule_id}로 전달합니다. 봇 ID는 봇 상세 페이지의 작업 → 봇 ID 복사하기에서 복사할 수 있습니다.

예시 8f3a7c1e9b5d24f6

응답 필드

result: String

요청 처리 결과.

허용값 success, error
version: String

API 버전.

예시 v4
request_id: String

요청 추적용 ID.

예시 req_5a8c1f1c-...
elapsed_sec: Float

응답 생성에 걸린 시간(초 단위 Float).

예시 0.0098
data: Object
크롤링 봇 메타와 파라미터 정보.
- id: String
  
  크롤링 봇의 ID(echo).
- name: String
  
  크롤링 봇 이름.
- param_info: Object
  크롤링 봇의 입력 파라미터 정보. 키는 param1~paramN으로 안정적이며, 사용으로 지정된 항목만 포함됩니다.
  - name: String
    
    파라미터 라벨(한국어).
  - name_en: String
    
    파라미터 라벨(영문). 설정되지 않은 경우 키 자체가 생략됩니다.
  - alias: String
    
    이 파라미터에 설정된 영문 별칭. 요청 시 paramN 대신 이 키로 보낼 수 있습니다. (미설정 시 생략)
  - value: String | null
    
    현재 크롤링 봇에 저장된 값. 미설정이면 null.
  - options: Array<Object>
    
    이 파라미터에 허용된 값 목록. 자유 입력 파라미터는 키 자체가 생략됩니다. 각 항목은 name(한글)·name_en(영문)·value(collect 호출 시 보낼 실제 값)로 구성됩니다.

에러 응답

MISSING_API_KEY

Authorization 헤더가 없거나 형식이 올바르지 않습니다. Authorization: Bearer <api_key> 형태로 전달하세요. (HTTP 401)

{
  "result": "error",
  "version": "v4",
  "request_id": "req_5a8c1f1c-...",
  "code": "MISSING_API_KEY",
  "message": "API key is missing.",
  "elapsed_sec": 0.0008,
  "details": { "hint": "Send `Authorization: Bearer <api_key>` header." }
}

INVALID_API_KEY

전달된 API 키와 일치하는 사용자가 없습니다. (HTTP 401)

{
  "result": "error",
  "version": "v4",
  "request_id": "req_5a8c1f1c-...",
  "code": "INVALID_API_KEY",
  "message": "API key is invalid.",
  "elapsed_sec": 0.0011
}

SCHEDULE_NOT_FOUND

전달된 ID로 크롤링 봇을 찾을 수 없거나 접근 권한이 없습니다. (HTTP 404)

{
  "result": "error",
  "version": "v4",
  "request_id": "req_5a8c1f1c-...",
  "code": "SCHEDULE_NOT_FOUND",
  "message": "Schedule not found.",
  "elapsed_sec": 0.0021,
  "details": { "resource": "schedule", "id": "8f3a7c1e9b5d24f6" }
}

요청 파라미터

응답 필드

에러 응답

관련 가이드