스크래퍼 파라미터 정보 조회 V2

POST api.hashscraper.com/api/get_param_info Content-Type: application/json; version=2

스크래퍼가 사용하는 파라미터(param1~param10)의 의미를 조회합니다.

collect·set_schedule 호출 전에 해당 스크래퍼가 어떤 파라미터를 사용하고 각 파라미터가 무엇을 의미하는지 미리 확인할 때 사용합니다.

응답의 param_info 객체는 다른 가이드의 param_info와 형식이 다릅니다. 키는 사용 중인 파라미터 이름(param1~param10), 값은 해당 파라미터의 라벨 문자열입니다.

요청 파라미터

  • api_key: String
    해시스크래퍼 API 키API키 확인하기
    예시 YOUR_API_KEY
  • schedule_id: String
    조회할 스크래퍼의 ID.
    예시 YOUR_SCHEDULE_ID

응답 필드

  • result: String
    요청 처리 결과.
    허용값 success, error
  • version: String
    API 버전.
    예시 v2
  • name: String
    스크래퍼의 이름.
  • schedule_id: String
    스크래퍼의 식별자.
  • param_info: Object
    스크래퍼가 사용 중인 파라미터의 라벨 매핑. 사용으로 지정된 param1~param10만 키로 포함되며, 값은 해당 파라미터의 라벨(예: 검색어)입니다. 스크래퍼에 라벨이 설정되지 않은 항목은 값이 null로 반환됩니다.
  • elapsed_time: Float
    응답 생성에 걸린 시간(초 단위 숫자).
    예시 0.0123

에러 응답

  • schedule_id missing
    필수 파라미터 schedule_id가 누락되었습니다.
    {
      "result": "error",
      "version": "v2",
      "message": "`schedule_id` parameter is required"
    }
  • Schedule not found
    전달된 schedule_id로 스크래퍼를 찾을 수 없거나 접근 권한이 없습니다.
    {
      "result": "error",
      "version": "v2",
      "message": "schedule(id: YOUR_SCHEDULE_ID) not found"
    }

관련 가이드

요청 예시
  • cURL
  • Ruby
  • Python
  • NodeJS
  • PHP
  • Java
응답 예시 200
{
  "result": "success",
  "version": "v2",
  "name": "사람인 채용공고 수집",
  "schedule_id": "사람인_채용공고_수집_1697441449957",
  "param_info": {
    "param1": "검색할 키워드",
    "param2": "최대 수집 개수"
  },
  "elapsed_time": 0.0123
}