비대면 계약 - ExportAPI 설명

ExportAPI 란 비대면 계약시작시 export_api_info Parameter 값을 통하여 설정한 정보를 기반으로 계약자가 계약서를 승인, 반려시에 설정 값을 기반으로 만들어진 JSON 형식의 body 를 설정한 URL에 export 하여 해당 회사측에서 받을 수 있게 해주는 기능입니다.

request_code 에 사용자 정의 대신 "embed" 를 입력 할 경우 계약서 진행 URL을 export 해주며 카카오톡 및 이메일 알림이 계약자에게 발송되지 않습니다. export 받은 URL을 기반으로 고객측에서 발송을 따로 진행 할 수 있습니다.

embed Code를 사용 할 경우 최초 비대면 계약 호출시 response로 계약 시작 URL을 제공하며 계약을 진행 시 서명자가 계약서를 승인, 반려 할 때마다 export 로 진행 URL 과 입력하셨던 계약자의 번호 또는 이메일을 제공합니다. ( 이메일로 호출한 경우 이메일, 번호로 호출한 경우 번호 ) 계약 완료시엔 문서 다운로드가 가능하도록 문서 다운로드, 이력 인증서 다운로드 URL을 제공합니다. ※ 계약 완료시 받을수 있는 URL 형식은 link_type 옵션으로 viewer, download 중 하나로 선택가능합니다.

Parameter

Parameter Name	DataType	Description
export_api_info	Data	작성 데이터를 내보낼시에 설정하는 값
export_api_info.api_type	String	"StartAndEnd"(시작과 끝만) or "ALL" (전부)
export_api_info.url	String	통신 받을 url
export_api_info.authorization	String	데이터를 수신받을때 헤더 authorization 로 설정하고 싶은 값 (수신측에서 암호토큰을 받아서 보안상 활용하고 싶으신경우)
export_api_info.link_type	String	embed 전용옵션 문서 완료 시 이력인증서, PDF 문서 URL의 type을 변경 default - viewer URL "download" - download URL
export_api_info.request_code	String	고객이 정의하는 임의의 값 "embed" - 설명 참조
export_api_info.request_params	Data	받아올 필드의 정보를 가진 Data
export_api_info.request_params.param_id	String	받아올 파라미터 이름(사용자 지정)
export_api_info.request_params.param_value	String	""
export_api_info.request_params.fields	Data	서식 내부에 있는 필드명을 조회하여 필드이름에 해당하는 값이 문서에 존재할 경우 param_value 대신에 들어가는 값
export_api_info.request_params.fields.doc_id	String	서식 ID
export_api_info.request_params.fields.field_name	String	값을 가져올 서식 내 필드 명

export_api Response)

{
	"header": {
		"api_name": "export",
		"session_id": "S1001",
		"request_code": "{ exportAPI_info 에서 지정한 request_code 값 }"
	},
	"body": {
		"wfluid": "0", //이싸인온에서 사용하는 서식구분id
		"clientid": "{ eSignonAPI 사용을 위한 Unique ID }",
		"processid": "1", //이싸인온에서 사용하는 process 구분값
		"requestid": "{ header 의 request_code 값 }",
		"actionid": "1", //이싸인온에서 사용하는 action 구분값
		"workdatetime": "2020-01-31 04:23:28.0", //작성완료시간 UTC±00:00
		"worktype": "CF", //CF=승인, RT=반려 작성자가 2단계 이상의 문서에서는 승인, 반려를 선택할 수 있음.
		"wfuid": "{}", //이싸인온에서 사용하는 문서구분id
		"useremail": "{ 서명자 이메일or휴대폰번호 }", 
		"opinion": "", //승인, 반려시 고객들이 반려 메세지,전송 메세지를 사용한 경우 출력
		"param_id": "param_value", // 서식에 field_name으로 등록한 필드 박스의 값이 없을경우 param_id:param_value return  
															 //	값이 있을경우엔 param_id:field_value를 return
		"status":"{Playing}", // 진행 상태 - Playing 진행중 / Complete 완료 / Canceled 취소됨
	}
}

export_api 응답 예시) code-embed 상태 일 때 ( 진행중 )

{
	"header": {
		"api_name": "export",
		"session_id": "S1001",
		"request_code": "{embed로 고정}"
	},
	"body": {
		"wfluid": "0", //이싸인온에서 사용하는 서식구분id
		"clientid": "{ eSignonAPI 사용을 위한 Unique ID }",
		"processid": "1", //이싸인온에서 사용하는 process 구분값
		"requestid": "{ embed로 고정 }",
		"actionid": "1", //이싸인온에서 사용하는 action 구분값
		"workdatetime": "2020-01-31 04:23:28.0", //작성완료시간 UTC±00:00
		"worktype": "CF", //CF=승인, RT=반려 작성자가 2단계 이상의 문서에서는 승인, 반려를 선택할 수 있음.
		"wfuid": "{}", //이싸인온에서 사용하는 문서구분id
		"useremail": "{ 서명자 이메일or휴대폰번호 }", 
		"opinion": "", //승인, 반려시 고객들이 반려 메세지,전송 메세지를 사용한 경우 출력
		"param_id": "param_value", // fields 값을 설정한 경우 fields_value를 return
		"next_play_user":"{다음 차례로 서명할 이메일 or 휴대폰 번호}",
		"play_url":"{다음 차례로 서명할 고객에게 전달할 URL}",
		"status":"{Playing}", // 진행 상태 - Playing 진행중 / Complete 완료 / Canceled 취소됨
		"next_user_name":"{다음 서명자 이름}",
		"user_name":"{현재 서명자 이름}"
	}
}

export_api 응답 예시) code-embed 상태 일 때 ( 완료 )

{
	"header": {
		"api_name": "export",
		"session_id": "S1001",
		"request_code": "{embed로 고정}"
	},
	"body": {
		"wfluid": "0", //이싸인온에서 사용하는 서식구분id
		"clientid": "{ eSignonAPI 사용을 위한 Unique ID }",
		"processid": "1", //이싸인온에서 사용하는 process 구분값
		"requestid": "{ embed로 고정 }",
		"actionid": "1", //이싸인온에서 사용하는 action 구분값
		"workdatetime": "2020-01-31 04:23:28.0", //작성완료시간 UTC±00:00
		"worktype": "CF", //CF=승인, RT=반려 작성자가 2단계 이상의 문서에서는 승인, 반려를 선택할 수 있음.
		"wfuid": "{}", //이싸인온에서 사용하는 문서구분id
		"useremail": "{ 서명자 이메일or휴대폰번호 }", 
		"opinion": "", //승인, 반려시 고객들이 반려 메세지,전송 메세지를 사용한 경우 출력
		"param_id": "param_value", // fields 값을 설정한 경우 fields_value를 return
		"cert_url":"{이력 인증서 다운로드 URL}", // link_type 옵션으로 URL 종류 선택가능
		"download_url":"{문서 다운로드 URL}", // link_type 옵션으로 URL 종류 선택가능
		"status":"{Complete}", // 진행 상태 - Playing 진행중 / Complete 완료 / Canceled 취소됨
		"user_name":"{현재 서명자 이름}"
	}
}