증명서

1. 증명서 문서 뷰 파라미터 준비nps_edi.b1.certificates.application_results.document_view

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

샌드박스입니다. 실제 기관을 호출하지 않는 모의 응답이며 일일 한도가 없습니다.

선택한 증명서 1건의 인쇄·저장용 문서 뷰 파라미터를 준비합니다. 실제 인쇄 API는 호출하지 않습니다(read-only).

증명서 신청 결과 목록을 먼저 조회하거나, 세션에 남아 있는 결과 행을 사용합니다. [국민연금공단 EDI 로그인]
select와 달리 첫 행 자동 선택 없음. selector 1개 이상으로 1건을 지정해야 합니다.

Request

변수명	필수	설명
Authorization	Y	API 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다. 형식 : Basic base64("{client_id}:{client_secret}") [참고] 인증
X-Env-Scope	Y	호출 환경입니다. `sandbox`샌드박스 — 모의 응답 `real_test`데모 — 하루 100 사용 토큰 `production`정식 — 유료 플랜 전용 [참고] 환경
Idempotency-Key	Y	재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다. [참고] 재시도
Content-Type	Y	요청 본문 형식입니다. `application/json`고정값 (기본값)
X-Trace-Id	N	추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.

변수명	타입	길이	필수	설명
provider	string	-	Y	호출할 기관입니다. `nps_edi`이 API 고정값 (기본값) 예시 : nps_edi
action	string	-	Y	호출할 작업입니다. `nps_edi.b1.certificates.application_results.document_view`이 API 고정값 (기본값) 예시 : nps_edi.b1.certificates.application_results.document_view
account_link_id	string	36	조건부	등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다. 형식 : UUID v4 [참고] 자격증명 등록
params	object	-	Y	작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fields	object	-	N	민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다. [참고] 암호화

변수명	타입	필수	설명
row_index	number	N	search options[].row_index
row_key	string	N	search options[].row_key
document_no	string	N	전자문서번호 docNo. 캐시 없을 때 template_code와 함께 search 자동 실행
receipt_no	string	N	접수 전자문서번호 rcvDocNo
template_code	string	N	양식 코드 필터 (예 EC02, EC15)
row_text_contains	string	N	행 텍스트 부분 일치 필터
run_precheck	boolean	N	getOHJC0014M01 사전검증 호출. 기본 true
include_ec15_report_rows	boolean	N	EC15일 때 getOHJC0020M0 read-only 행 포함. 인쇄 차단. 기본 false

bash

curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: sandbox' \
  --header 'Idempotency-Key: demo-document_view-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.certificates.application_results.document_view",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'

Response

view_action·detail_params를 확인합니다. error_code는 null.

순번	변수명	설명
	view_action	문서 뷰 액션 코드
	detail_params	인쇄·저장용 상세 파라미터 객체
	selected_option	선택한 처리결과 행 정보
	document	선택 문서 정보 (문서번호, 접수번호, 서식 코드와 이름, 처리상태, 통지일시)
	workplace	사업장 정보 (사업장관리번호, 사업자번호, 연금번호, 사업장명, 지사, 가입자 수)
	precheck	인쇄와 저장 전 사전 점검 결과
	ec15_report_rows	EC15 보고서 행
	ec15_report_row_count	EC15 보고서 행 수
	workflow_contract	연동 방식 정보 (전송 방식과 화면 호출 경로)

json

// result.data
{
  "view_action": {},
  "detail_params": {},
  "selected_option": {},
  "document": {},
  "workplace": {},
  "precheck": {},
  "ec15_report_rows": [],
  "ec15_report_row_count": 1,
  "workflow_contract": {}
}

순번	오류 코드	발생 조건
	PROVIDER_VALIDATION_ERROR	행 없음 — 조건에 맞는 행을 찾지 못했습니다.

2. 증명서 신청 처리결과 검색nps_edi.b1.certificates.application_results.search

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

샌드박스입니다. 실제 기관을 호출하지 않는 모의 응답이며 일일 한도가 없습니다.

증명서 신청·발급 처리결과 목록을 검색합니다. 결과 행은 세션에 캐시되어 document_view에서 재사용됩니다.

로그인을 먼저 호출해 세션을 만든 뒤, 같은 account_link_id 로 호출합니다. [국민연금공단 EDI 로그인]
result.data.error_code=CERTIFICATE_APPLICATION_RESULTS_EMPTY.
날짜 미입력 시 최근 90일.

Request

변수명	필수	설명
Authorization	Y	API 자격증명입니다. client_id 와 client_secret 을 콜론으로 이어 Base64 로 인코딩해 보냅니다. 형식 : Basic base64("{client_id}:{client_secret}") [참고] 인증
X-Env-Scope	Y	호출 환경입니다. `sandbox`샌드박스 — 모의 응답 `real_test`데모 — 하루 100 사용 토큰 `production`정식 — 유료 플랜 전용 [참고] 환경
Idempotency-Key	Y	재시도 식별 키입니다. 같은 키와 같은 본문으로 다시 호출하면 기존 작업이 그대로 반환됩니다. ASCII 문자만 사용하며 UUID v4 를 권장합니다. 고객 정보는 넣지 않습니다. [참고] 재시도
Content-Type	Y	요청 본문 형식입니다. `application/json`고정값 (기본값)
X-Trace-Id	N	추적 아이디입니다. 지정하지 않으면 서버가 발급합니다.

변수명	타입	길이	필수	설명
provider	string	-	Y	호출할 기관입니다. `nps_edi`이 API 고정값 (기본값) 예시 : nps_edi
action	string	-	Y	호출할 작업입니다. `nps_edi.b1.certificates.application_results.search`이 API 고정값 (기본값) 예시 : nps_edi.b1.certificates.application_results.search
account_link_id	string	36	조건부	등록한 자격증명을 가리키는 아이디입니다. 생략하면 이 계정이 그 기관에 등록한 자격증명 중 대표로 지정한 것이 쓰입니다. 대표가 없으면 등록한 자격증명이 하나뿐일 때만 자동으로 선택되고, 둘 이상이면 직접 지정해야 합니다. 형식 : UUID v4 [참고] 자격증명 등록
params	object	-	Y	작업 파라미터입니다. 아래 params 파라미터 표의 필수 항목을 채워 보냅니다.
encrypted_fields	object	-	N	민감한 params 값을 RSA-OAEP-256 으로 암호화해 담는 객체입니다. 서버가 복호화해 params 에 합칩니다. 같은 이름을 params 와 함께 쓰지 않습니다. [참고] 암호화

변수명	타입	길이	필수	설명
start_date	string	8	N	검색 시작일 미입력 시 오늘 기준 90일 전 형식 : YYYYMMDD
end_date	string	8	N	검색 종료일 미입력 시 오늘 형식 : YYYYMMDD
template_code	string	-	N	증명서 양식 코드. A·빈값=전체
member_name	string	-	N	가입자(신청인) 성명 jnprNm
member_resident_no	string	-	N	가입자 주민등록번호 jnprErrno
processing_status_code	string	-	N	처리상태. A=전체, C=정상, S=오류
confirm_status_code	string	-	N	확인상태 wediSnrSttsCd2
row_text_contains	string	-	N	행 텍스트 부분 일치 필터 (서버측 후처리)
page_no	number	-	N	페이지 번호. 기본 1
page_per_count	number	-	N	페이지당 행 수. 기본 10

bash

curl --request POST \
  --url 'https://api.xdata.kr/v1/jobs' \
  --header 'Authorization: Basic {base64(client_id:client_secret)}' \
  --header 'X-Env-Scope: sandbox' \
  --header 'Idempotency-Key: demo-search-001' \
  --header 'Content-Type: application/json' \
  --data '{
  "provider": "nps_edi",
  "action": "nps_edi.b1.certificates.application_results.search",
  "account_link_id": "9b4c3a2f-0000-4000-8000-000000000000",
  "params": {}
}'

Response

options·rows를 확인합니다.

순번	변수명	설명
	options	증명서 신청결과 행 배열
	rows	처리결과 행 배열 (options와 동일)
	row_count	반환 행 수
	source_row_count	기관 응답 원본 행 수
	workplace	사업장 정보 (사업장관리번호, 사업자번호, 연금번호, 사업장명, 지사, 가입자 수)
	search	이번 조회에 쓰인 조회 조건
	page	페이지 정보
	template_options	증명서 서식 선택지
	processing_status_options	처리상태 선택지
	workflow_contract	연동 방식 정보 (전송 방식과 화면 호출 경로)

json

// result.data
{
  "options": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "rows": [
    {
      "row_index": 0,
      "row_key": "..."
    }
  ],
  "row_count": 1,
  "source_row_count": 1,
  "workplace": {},
  "search": {},
  "page": {},
  "template_options": [],
  "processing_status_options": [],
  "workflow_contract": {}
}