export_api 값을 따로 설정하여 받아올 값의 형식을 지정할 수 있습니다.(선택사항)
export_api 란 고객님이 진행중 승인, 반려를 할 경우 설정된 값을 설정된 URL로 esignon에서 request 해주는 기능입니다.
※ Body 파라미터 중 Required 값은 필수 값이므로 입력하지 않으시면 요청에 실패합니다. 또한, Optional 이지만 Array 타입의 파라미터를 사용하실 경우 Array 내부 파라미터 값 중 Required 값을 꼭 입력해주셔야 합니다. 사용을 하지 않으실 경우에 내부 파라미터를 입력하실 필요가 없습니다.
※ language 파리미터의 경우 기본값 "ko-KR" ( 설정 안했을경우 )
API 주소 정보
Request
Parameters
PathParameters
Headers
Body
Body - Header Parameter
Body - Body Parameter
Request Body Example
{"header": {"request_code":"5005Q","version":"9.9.99" },"body": {"biz_id":"0","workflow_name":"{ 작성할 문서명 }","memb_email":"{ 계약 시작자 이메일 }","doc_id":"{서식 ID}","language":"ko-KR","comment":"","expireddate":"YYYY-MM-DD","player_list": [{"field_owner":"1","email":"{ 받는 사람 email or 받는 사람 휴대폰 번호 }","name":"{ 받는 사람 이름 }","mobile_number":"{ 휴대폰 본인인증시 사용할 휴대폰번호 }","password_hint":"{ 비밀번호 힌트 }","password":"{비밀번호}" },{"field_owner":"2","email":"{}","name":"{}","mobile_number":"{}","password_hint":"{}","password":"{}" }],"field_list": [{"field_name":"{ field_name }","field_value":"{ field_value }" } ],"customer_list": [{"email":"{ id_type에 따라서 참조자 이메일 or 휴대폰번호 }","name":"{ 참조자 이름 }" }],"export_api_info": {"api_type":"{ StartAndEnd or ALL }","url":"{ 통신 받을 url }","link_type":"{download or null}","request_code":"{ 고객이 정의하는 임의 값 }","authorization":"{설정 URL로 request 시에 Header - authorization 으로 받아올 값 }","request_params": [{"param_id":"{받아올 파라미터 이름(사용자 지정)}","param_value":"{fields에서 설정한 값이 없을 경우 받아올 기본 값}","fields": [{ "doc_id":"{ 서식 ID }","field_name":"{ 값을 가져올 서식 내 필드명 }" }] }] } }}
request_params
서식에 field_name으로 등록한 필드 박스의 값이 없을경우 param_id:param_value return
값이 있을경우엔 param_id:field_value를 return
Request Body Example - only Required
{"header": {"request_code":"5005Q","version":"9.9.99" },"body": {"biz_id":"0","workflow_name":"{ 작성할 문서명 }","memb_email":"{ 계약 시작자 이메일 }","doc_id":"{서식 ID}","language":"ko-KR","player_list": [{"field_owner":"1","email":"{ 받는 사람 email or 받는 사람 번호 }","name":"{ 받는 사람 이름 }" }, {"field_owner":"2","email":"{}","name":"{}" }] }}
{ "header":{"session_id":"S1001","response_code":"5005A","result_code":"00","result_msg":"Work Flow가 시작됩니다.","version":"9.9.99" },"body":{ "comp_id":"{ 회사 ID }","biz_id":"0","memb_email":"{ 계약 시작자 이메일 }","workflow_id":"{ 문서아이디 }","workflow_name":"{ 시작된 서식 이름 }","token":"{ 문서를 시작한 사람이 계약의 첫번째 작성자일 경우 작성페이지에 접근할때 사용하는 토큰값 }","lang":"ko-KR" }}
Response 로 수신한 토큰을 https://docs.esignon.net/mail/sign?token=:token 경로에 token 값을 입력
한뒤 접근하면 진행중인 계약서에 접근할 수 있습니다.
( 생성자 기준으로 발급되는 token 입니다. 생성자가 만약 계약 단계에 있을경우 해당 URL로 서명이 가능
그 외의 경우에는 해당 URL로 진행중인 문서 확인이 가능합니다. )
Response export_api Example
{"header": {"api_name":"export","session_id":"S1001","request_code":"{ exportAPI_info 에서 지정한 request_code 값 }","authorization":"{ 비대면 계약 API 사용시 설정했던 authorization 값 }" },"body": {"clientid":"{ eSignonAPI 사용을 위한 Unique ID }","processid":"1",//문서의 진행 단계 구분값"requestid":"{ header 의 request_code 값 }","actionid":"1",//문서의 진행 단계 구분값"workdatetime":"2020-01-31 04:23:28.0",//작성완료시간"worktype":"CF",//CF=승인, RT=반려 ( 처음 계약자가 반려시 문서는 취소 처리됩니다.)"wfuid":"{}",//문서의 고유ID"useremail":"{ 서명자 이메일or휴대폰번호 }","opinion":"",//승인, 반려시 고객들이 반려 메세지,전송 메세지를 사용한 경우 출력"param_id":"param_value",// fields 값을 설정한 경우 fields_value를 return }}