SignOK

임베디드 전자계약 생성

에디터 화면으로 전자계약 문서를 생성합니다.

URL

/api/v2/document/embedded

Request

테이블정보입력필요

Name

Type

Required

Description

redirect_url

String

서명제출 또는 거부 시 redirect 시킬 URL(default signok)

expired_day

Integer

계약 만료일 설정(현재날짜 기준에서 추가되는 일수)

* default 14일

send_parameter

Boolean

redirect_url에 문서ID 및 서명결과를 parameter로 전송 여부(GET)

* redirect_url?id=문서ID&signSttsCd=EDPSC002,003

auto_send

Boolean

자동 발송 여부(Default false)

target_origin

String

Postmessage 전달받을 URL

* window.open으로 열었을 경우 부모창의 URL

use_sms

Boolean

SMS사용 여부(Default false)

signer_readonly

Boolean

서명자 정보 입력 readonly 여부

attach_files

Array

전자문서 첨부파일

테이블정보입력필요
name	String	전자문서 첨부파일 명(확장자포함)
file	String	Base64 인코딩된 첨부파일
extension	String	첨부파일 확장자

title

String

Required

문서 제목

search_code

String

검색 코드

document_file

Object

Required

문서파일

테이블정보입력필요
extension	String	Required	파일 확장자
file	String	Required	Base64인코딩된 파일

send_option

Object

발송옵션 배열

테이블정보입력필요
sign_request	Boolean		서명요청 발송여부(Default true) * 해당옵션이 false인 경우 auto_send 무시
sign_complete	Boolean		서명완료 발송여부(Default true)

signer

Array

Required

서명 대상자 배열

테이블정보입력필요

index

Integer

Required

대상자 순번

String

Required

대상자 ID값

name

String

Required

대상자 이름

contact

String

Required

대상자 연락처(이메일/휴대폰)

type

String

Required

대상자 구분 : SIGNATORY(서명자), REVIEWER(검토자)

sign_method

String

Required

서명방법 : SIMPLE(간편서명), CERTIFICATE(공동인증서서명)

items

Array

Required

입력항목 리스트

테이블정보입력필요
type	String	입력항목 타입 : STAMP, TEXT, CHECKBOX, SELECTBOX
alias	String	항목명
required	Boolean	필수여부
width	Integer	입력항목 가로 사이즈
height	Integer	입력항목 세로 사이즈
x	Integer	입력항목 가로 좌표
y	Integer	입력항목 세로 좌표
page	Integer	입력항목이 만들어질 페이지
font_size	Integer	폰트 사이즈 (type이 TEXT 일때 적용)
text_align	String	텍스트 정렬 : LEFT, CENTER, RIGHT
options	Array	셀렉트 박스 옵션항목 (type이 SELECTBOX 일때 적용)

테이블정보입력필요
value	String		셀렉트 박스 옵션값

auth

Object

문서 열람 인증 설정

테이블정보입력필요
password	String	비밀번호
simple	String	간편인증용 실명(설정 시 contact는 휴대폰번호 필수)
hp	String	휴대폰인증용 실명(설정 시 contact는 휴대폰번호 필수)
biz_no	String	법인 공동인증서 인증용 사업자번호(설정 시 contact는 이메일 필수)

memo

String

전달메시지

attach_files

Array

첨부파일 요청

테이블정보입력필요
name	String	요청 첨부파일 이름
description	String	요청 첨부파일 설명
required	Boolean	필수 여부

cc_list

Array

참조자 리스트

테이블정보입력필요
contact	String		연락처 정보 (이메일 또는 휴대폰번호)

Response

테이블정보입력필요

Name

Type

Required

Description

result

Object

Required

결과 데이터

테이블정보입력필요
id	String	Required	문서 ID
url	String	Required	문서생성 에디터 화면 URL

code

String

Required

성공, 실패 코드

message

String

Required

성공, 실패 메세지

Request

Response

임베디드 템플릿 생성

에디터 화면으로 템플릿을 생성합니다.

URL

/api/v2/template/embedded

Request

테이블정보입력필요

Name

Type

Required

Description

title

String

Required

문서 제목

attach_files

Array

전자문서 첨부파일

테이블정보입력필요
name	String	전자문서 첨부파일 명(확장자포함)
file	String	Base64 인코딩된 첨부파일
extension	String	첨부파일 확장자

options

Object

옵션 배열

테이블정보입력필요
meet	Boolean		대면서명 여부
signer_order	Boolean		순차서명 여부

signer

Array

Required

서명 대상자 배열

테이블정보입력필요

index

Integer

Required

대상자 순번

type

String

Required

대상자 구분 : SIGNATORY(서명자), REVIEWER(검토자)

sign_method

String

Required

서명방법 : SIMPLE(간편서명), CERTIFICATE(공동인증서서명)

name

String

Required

대상자 이름

contact

String

Required

대상자 연락처(이메일/휴대폰)

items

Array

Required

입력항목 리스트

테이블정보입력필요
type	String	입력항목 타입 : STAMP, TEXT, CHECKBOX, SELECTBOX
alias	String	항목명
required	Boolean	필수여부
width	Integer	입력항목 가로 사이즈
height	Integer	입력항목 세로 사이즈
x	Integer	입력항목 가로 좌표
y	Integer	입력항목 세로 좌표
page	Integer	입력항목이 만들어질 페이지
font_size	Integer	폰트 사이즈 (type이 TEXT 일때 적용)
text_align	String	텍스트 정렬 : LEFT, CENTER, RIGHT
options	Array	셀렉트 박스 옵션항목 (type이 SELECTBOX 일때 적용)

테이블정보입력필요
value	String		셀렉트 박스 옵션값

attach_files

Array

첨부파일 요청

테이블정보입력필요
name	String	요청 첨부파일 이름
description	String	요청 첨부파일 설명
required	Boolean	필수 여부

auth

Object

문서 열람 인증 설정

테이블정보입력필요
password	String	비밀번호
hp	String	휴대폰인증용 실명(설정 시 contact는 휴대폰번호 필수)
simple	String	간편인증용 실명(설정 시 contact는 휴대폰번호 필수)
biz_no	String	법인 공동인증서 인증용 사업자번호

document_file

Object

Required

문서파일

테이블정보입력필요
extension	String	Required	파일 확장자
file	String	Required	Base64인코딩된 파일

Response

테이블정보입력필요

Name

Type

Required

Description

result

Object

Required

결과 데이터

테이블정보입력필요
id	String	Required	템플릿 ID
url	String	Required	문서생성 에디터 화면 URL

code

String

Required

성공, 실패 코드

message

String

Required

성공, 실패 메세지

Request

Response

임베디드 템플릿으로 전자계약 생성

템플릿 에디터 화면으로 전자 계약 문서를 생성합니다.

URL

/api/v2/document/embedded-by-tempate

Request

테이블정보입력필요

Name

Type

Required

Description

use_sms

Boolean

SMS사용 여부(Default false)

send_option

Object

발송옵션

테이블정보입력필요
sign_request	Boolean		서명요청 발송여부(Default true) * 해당옵션이 false인 경우 auto_send 무시
sign_complete	Boolean		서명완료 발송여부(Default true)

redirect_url

String

서명제출 또는 거부 시 redirect 시킬 URL(default signok)

target_origin

String

Postmessage 전달받을 URL

* window.open으로 열었을 경우 부모창의 URL

send_parameter

Boolean

redirect_url에 문서ID 및 서명결과를 parameter로 전송 여부(GET)

* redirect_url?id=문서ID&signSttsCd=EDPSC002,003

search_code

String

검색 코드

template_id

String

Required

템플릿 ID

expired_day

Integer

계약 만료일 설정(현재날짜 기준에서 추가되는 일수)

* default 14일

auto_send

Boolean

자동 발송 여부(Default false)

signer

Array

Required

서명 대상자 배열

테이블정보입력필요

index

Integer

Required

대상자 순번

String

Required

대상자 ID값

name

String

Required

대상자 이름

contact

String

Required

대상자 연락처(이메일/휴대폰)

items

Array

Required

항목 배열

테이블정보입력필요
key	String	API Key
value	String	값
image	String	Base64 인코딩된 서명 이미지
checked	Boolean	RADIO, CHECKBOX 체크 여부

auth

Object

문서 열람 인증 설정

테이블정보입력필요
password	String	비밀번호
simple	String	간편인증용 실명
simple_cert	String	간편인증용 휴대폰번호
hp	String	휴대폰인증용 실명
hp_cert	String	휴대폰인증용 휴대폰번호
biz_no	String	법인 공동인증서 인증용 사업자번호(설정 시 contact는 이메일 필수)

memo

String

전달메시지

lang_se_cd

String

언어 설정 코드

cc_list

Array

참조자 리스트

테이블정보입력필요
contact	String		연락처 정보(이메일 또는 휴대폰번호)

Response

테이블정보입력필요

Name

Type

Required

Description

result

Object

Required

결과 데이터

테이블정보입력필요
id	String	Required	템플릿 ID
url	String	Required	문서생성 에디터 화면 URL

code

String

Required

성공, 실패 코드

message

String

Required

성공, 실패 메세지

Request

Response

API 목차