개발자 문서
API 레퍼런스

폐기물 행정처분 - 공공데이터 기업 위험 조회

1. 사업장폐기물 행정처분 조회opendata.env.waste_sanction

MCP 도구 이름 opendata__env__waste_sanction

POSThttps://api.xdata.kr/v1/jobsX-Env-Scope: real_test

현재 혜택은 요금제에서 확인해 주세요. 현재 데모 정책과 계정의 남은 양을 확인해 주세요.

사업자등록번호로 사업장폐기물 관련 행정처분 이력과 위반내용을 조회합니다.

  • 이 API 는 기관 연동과 기관 로그인이 필요 없습니다. 기관 자격증명을 등록하지 않아도 호출할 수 있고, account_link_id 는 보내지 않습니다.

Request

순번변수명필수설명
AuthorizationYAPI 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다.

형식 : Basic base64("{client_id}:{client_secret}")

[참고] 인증

X-Env-ScopeY호출 환경입니다.
  • real_test데모 — 현재 데모 한도 확인 필요
  • production정식 — 현재 공개 요금제 전용

[참고] 환경

Idempotency-KeyY재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다.

[참고] 재시도

Content-TypeY요청 본문 형식입니다.
  • application/json고정값 (기본값)
X-Trace-IdN추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.
순번변수명타입필수설명
providerstringY호출할 기관입니다.
  • opendata이 API 고정값 (기본값)

예시 : opendata

actionstringY호출할 작업입니다.
  • opendata.env.waste_sanction이 API 고정값 (기본값)

예시 : opendata.env.waste_sanction

paramsobjectY작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fieldsobjectN민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다.

[참고] 암호화

순번변수명타입필수설명
biznostringY사업자등록번호 10자리
output_formatsarrayN이 결과를 엑셀(xlsx) 파일로도 받으려면 적습니다. 예: ["xlsx"]. 파일은 result.artifacts 에 함께 오고, 빼면 데이터만 옵니다
  • 「<필수>」 자리는 예시 값이 없는 필수 칸입니다. 위 파라미터 표를 보고 실제 값으로 바꿔 보냅니다.
bash
curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: real_test' \
  --header "Idempotency-Key: waste_sanction-$(date +%s)-$RANDOM" \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "opendata",
  "action": "opendata.env.waste_sanction",
  "params": {
    "bizno": "<필수>"
  }
}'

Response

순번변수명타입설명
source_idstring이 작업의 원천 데이터셋 번호입니다. 이 작업에서는 항상 15156661 입니다(공공데이터포털 data.go.kr 의 번호).
actionstring호출한 작업 이름입니다. 이 작업에서는 항상 opendata.env.waste_sanction 입니다.
job_idstring이 결과를 만든 작업의 ID 입니다.
sourceobject원천의 출처 정보입니다. 결과를 사용자에게 보여 줄 때 출처 표시에 씁니다.
source.idstring원천 데이터셋 번호입니다. source_id 와 같은 값입니다.
source.orgstring원천 데이터를 제공하는 기관 이름입니다. 이 작업에서는 항상 한국환경공단 입니다.
source.licensestring원천 데이터의 이용 허락 범위 표기입니다. 값은 원천마다 다르고, 결과를 보여 줄 때 출처 표시와 함께 씁니다.
license_notesarray출처 표시 문구, 이용 허락 표기, 결과 해석 안내가 이 순서로 담긴 문장 목록입니다. 첫 줄은 「출처: 한국환경공단 사업장폐기물 행정처분 / data.go.kr 15156661」 입니다.
match_modestring조회 방식입니다. 이 작업에서는 항상 BATCH_M1_LOCAL_INDEX 로, 원천을 그때그때 부르지 않고 미리 모아 둔 색인에서 사업자등록번호가 같은 행을 찾았다는 뜻입니다.
matchesarray색인에서 찾은 폐기물 행정처분 행의 목록입니다. 유효기간이 지나지 않은 행만 담고, 비어 있으면 일치하는 행이 없다는 뜻이지 처분이 없다는 확인은 아닙니다.
matches[].brnostring | null사업자등록번호입니다.
matches[].bzenty_nmstring | null업체명입니다.
matches[].rprsv_nmstring | null대표자명입니다.
matches[].tpbiz_se_nmstring | null업종구분입니다.
matches[].admdsp_inst_nmstring | null행정처분기관입니다.
matches[].admdsp_ymdstring | null행정처분일자입니다.
matches[].bgng_ymdstring | null처분 시작일입니다.
matches[].end_ymdstring | null처분 종료일입니다.
matches[].vltn_dsctnstring | null위반내용입니다.
matches[].telgm_rcptn_ymdstring | null통보 접수일자입니다.
matches[].source_row_keystring색인이 행을 구별하려고 만든 키입니다. 업무 값이 아니라 결과 엑셀 파일에는 싣지 않습니다.
coverage_notestring이 조회의 범위와 한계를 알리는 안내문입니다. 비어 있는 matches 가 깨끗하다는 확인이 아니라는 점을 적습니다.
json
// result.data - 값 자리에는 각 칸의 형식을 적었습니다 (실제 값이 아닙니다)
{
  "source_id": "<string>",
  "action": "<string>",
  "job_id": "<string>",
  "source": {
    "id": "<string>",
    "org": "<string>",
    "license": "<string>"
  },
  "license_notes": [],
  "match_mode": "<string>",
  "matches": [
    {
      "brno": "<string | null>",
      "bzenty_nm": "<string | null>",
      "rprsv_nm": "<string | null>",
      "tpbiz_se_nm": "<string | null>",
      "admdsp_inst_nm": "<string | null>",
      "admdsp_ymd": "<string | null>",
      "bgng_ymd": "<string | null>",
      "end_ymd": "<string | null>",
      "vltn_dsctn": "<string | null>",
      "telgm_rcptn_ymd": "<string | null>",
      "source_row_key": "<string>"
    }
  ],
  "coverage_note": "<string>"
}
순번오류 코드발생 조건
PROVIDER_UNAVAILABLE조회에 쓰는 자료를 미리 받아 두는 조회라, 그 자료가 아직 준비되지 않았으면 작업이 이 오류로 끝나고 error.message 는 「조회에 쓰는 자료를 아직 준비하고 있어 지금은 결과를 드릴 수 없습니다. 조회 결과가 없다는 뜻이 아닙니다. 잠시 뒤 다시 시도해 주세요. 같은 안내가 이어지면 문의해 주세요.」 입니다. 결과가 없다는 뜻이 아니므로 잠시 뒤 다시 요청합니다.
VALIDATION_INVALID_FIELD요청 값이 맞지 않으면 작업이 이 오류로 끝나고, 요청을 고쳐 다시 요청합니다. 값이 빠지면 error.message 는 「요청에 필요한 값이 빠졌습니다. 빠진 값: 칸 이름. 그 값을 넣어 다시 요청해 주세요.」 꼴이고, 값의 형식이 틀리면 「요청 값이 올바르지 않습니다. 확인할 값: 칸 이름. 값을 고쳐 다시 요청해 주세요.」 꼴입니다(칸 이름이 다섯을 넘으면 앞 다섯과 「외 N개」 를 적습니다). 지원하지 않는 작업을 부르면 「지원하지 않는 작업입니다.」 입니다. 빠지거나 형식이 틀린 칸이 bizno 이면 그 꼴 대신 「사업자등록번호는 숫자 열 자리로 입력해 주세요.」 가 옵니다.
INTERNAL_ERRORXBOSS 쪽 설정이나 처리 결함으로 끝나면 이 오류가 나가고 error.message 는 「서버 내부 오류로 작업을 마치지 못했습니다. 서비스문의로 알려 주세요.」 입니다. 고객이 고칠 값이 없으므로 잠시 뒤 다시 요청하고, 계속되면 서비스문의로 알려 주세요.