데이터 수집 요청 V2

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

특정 스크래퍼에 새로운 데이터 수집 작업을 요청합니다.

요청 즉시 새 데이터셋을 생성하고 백그라운드에서 수집 작업을 시작합니다. 응답으로 반환된 schedule_result_id를 이후 상태·결과 조회에 사용하세요.

스크래퍼에 등록된 파라미터 사용 설정에 따라, param1~param5 중 사용으로 지정된 항목은 모두 채워서 보내야 합니다. 어떤 파라미터가 필요한지는 get_param_info로 미리 확인할 수 있습니다.

요청 본문에 포함된 param1~param5 값은 이번 수집뿐 아니라 스크래퍼 본체에도 저장되어 다음 실행의 기본값이 됩니다. 이번 요청에 포함되지 않은 항목은 빈 값으로 덮어쓰여지므로, 일부만 갱신할 의도라도 사용 중인 모든 파라미터를 함께 보내야 합니다.

이용권 기간이 만료되었거나 보유 크레딧이 부족하면 수집 요청이 거부됩니다. 이 경우 응답의 키는 message가 아닌 error_message로 내려옵니다.

요청 파라미터

  • api_key: String
    해시스크래퍼 API 키API키 확인하기
    예시 YOUR_API_KEY
  • schedule_id: String
    수집을 요청할 스크래퍼의 ID.
    예시 YOUR_SCHEDULE_ID
  • param1: optional String
    스크래퍼의 첫 번째 파라미터. 스크래퍼 설정에서 사용으로 지정되어 있으면 필수이며, 사용 안 함이면 입력 검증에서 제외됩니다. (단, 보낸 값은 응답의 param_info와 스크래퍼 본체에 그대로 반영됩니다.)
  • param2: optional String
    스크래퍼의 두 번째 파라미터. 동일한 규칙이 적용됩니다.
  • param3: optional String
    스크래퍼의 세 번째 파라미터. 동일한 규칙이 적용됩니다.
  • param4: optional String
    스크래퍼의 네 번째 파라미터. 동일한 규칙이 적용됩니다.
  • param5: optional String
    스크래퍼의 다섯 번째 파라미터. 동일한 규칙이 적용됩니다.
  • paramN (6 ≤ N ≤ 10): optional String
    일부 스크래퍼에서만 사용되는 추가 파라미터 슬롯입니다. 라벨이 붙지 않으며, 응답의 param_info에도 param6처럼 키 그대로 노출됩니다.

응답 필드

  • result: String
    요청 처리 결과.
    허용값 success, error
  • version: String
    API 버전.
    예시 v2
  • collect_info: Object
    수집 요청 결과 정보.
    • schedule_result_id: Integer
      이번 수집으로 생성된 데이터셋 ID. 이후 상태·결과 조회의 입력값으로 사용합니다.
    • schedule_id: String
      요청한 스크래퍼의 ID. 요청 시 전달한 값과 동일합니다.
    • param_info: Object
      이번 수집에 사용된 파라미터. param1~param5는 키 이름에 스크래퍼에 등록된 파라미터 라벨이 함께 표기됩니다 (예: param1(검색어)).
  • elapsed_time: Float
    응답 생성에 걸린 시간(초 단위 숫자).
    예시 0.6725

에러 응답

  • 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"
}
  • Required params missing
    스크래퍼에서 사용으로 지정된 param1~param5 항목 중 일부가 비어 있습니다. 메시지에 누락된 파라미터 이름이 함께 표시됩니다.
    {
  "result": "error",
  "version": "v2",
  "message": "사용되는 파라미터를 모두 입력해주세요. 사용되는 파라미터: [\"param1(검색어)\"]"
}
  • Service ticket expired
    이용권 기간이 만료되어 수집 요청이 거부되었습니다. 응답 키는 error_message입니다.
    {
  "result": "error",
  "version": "v2",
  "error_message": "서비스 이용권의 기간이 만료되었습니다."
}
  • Credit exhausted
    보유 크레딧을 모두 소진하여 수집 요청이 거부되었습니다. 응답 키는 error_message입니다.
    {
  "result": "error",
  "version": "v2",
  "error_message": "보유하신 크레딧을 모두 사용하셨습니다."
}
  • Schedule execution blocked
    이용권/크레딧 상태로 인해 수집을 시작할 수 없습니다. 메시지에 사유가 함께 표시되며, 가능한 사유는 No active service ticket, Credit exhausted, Service ticket expired, Invalid service ticket입니다.
    {
  "result": "error",
  "version": "v2",
  "message": "Schedule execution blocked: ..."
}

관련 가이드

요청 예시
  • cURL
  • Ruby
  • Python
  • NodeJS
  • PHP
  • Java
옵션 파라미터
응답 예시 200 
{
  "result": "success",
  "version": "v2",
  "collect_info": {
    "schedule_result_id": 13229287,
    "schedule_id": "사람인_채용공고_수집_1697441449957",
    "param_info": {
      "param1(검색할 키워드)": "개발자",
      "param2(최대 수집 개수)": "10"
    }
  },
  "elapsed_time": 0.6725
}