전자계약 문서생성
개요
싸인오케이 전자계약 문서를 생성합니다.
URL
/api/v2/document/create-general
요청 데이터
항목 | 타입 | 위치 | 설명 |
---|---|---|---|
title | String | body | 문서 제목 |
auto_send | Boolean | body | 자동발송 여부(Default false) |
search_code | String | body | 검색 코드 |
attach_files | Array | body | 전자문서 첨부파일 |
name | String | body | 전자문서 첨부파일 명(확장자포함) |
file | String | body | Base64 인코딩된 첨부파일 |
extension | String | body | 첨부파일 확장자 |
options | Object | body | - |
meet | Boolean | body | 대면서명 여부(Default false) |
signer_order | Boolean | body | 순차서명 여부(Default false) |
expired_day | Integer | body | 계약 만료일 설정(현재날짜 기준에서 추가되는 일수) |
signer | Array | body | 서명 대상자 배열 |
index | Integer | body | 대상자 순번 |
type | String | body | 대상자 구분 – SIGNATORY(서명자), REVIEWER(검토자) |
sign_method | String | body | 서명방법 – SIMPLE(간편서명), CERTIFICATE(공동인증서서명) |
name | String | body | 대상자 이름 |
contact | String | body | 대상자 연락처(이메일/휴대폰) |
items | Array | body | 입력항목 리스트 |
type | String | body | 입력항목 타입 - STAMP, TEXT, CHECKBOX, SELECTBOX |
alias | String | body | 항목명 |
required | Boolean | body | 필수여부 |
width | Integer | body | 입력항목 가로 사이즈 |
height | Integer | body | 입력항목 세로 사이즈 |
x | Integer | body | 입력항목 가로 좌표 |
y | Integer | body | 입력항목 세로 좌표 |
page | Integer | body | 입력항목이 만들어질 페이지 |
font_size | Integer | body | 폰트 사이즈 (type이 TEXT 일때 적용) |
text_align | String | body | 텍스트 정렬 - LEFT, CENTER, RIGHT |
options | Array | body | 셀렉트 박스 옵션항목 (type이 SELECTBOX 일때 적용) |
value | String | body | 셀렉트 박스 옵션값 |
attach_files | Array | body | 첨부파일 요청 |
name | String | body | 요청 첨부파일 이름 |
description | String | body | 요청 첨부파일 설명 |
required | Boolean | body | 필수 여부 |
auth | Object | body | 문서 열람 인증 설정 |
password | String | body | 비밀번호 |
hp | String | body | 휴대폰인증용 실명 (연락처가 휴대폰일 때 적용) |
simple | String | body | 간편인증용 실명 (연락처가 휴대폰일 때 적용) |
biz_no | String | body | 법인 공동인증서 인증용 사업자번호 |
memo | String | body | 남길말 |
cc_list | Array | body | 참조자 리스트 |
contact | String | body | 연락처 정보 (이메일 또는 휴대폰번호) |
document_file | Object | body | 문서파일 |
extension | String | body | 파일 확장자 |
file | String | body | Base64인코딩된 파일 |
응답 데이터
항목 | 타입 | 위치 | 설명 |
---|---|---|---|
result | Object | body | 결과 데이터 |
id | String | body | 문서 아이디 |
signer | Array | body | 서명 대상자 배열 |
index | Integer | body | 대상자 순번 |
name | String | body | 대상자 이름 |
view_url | String | body | 대상자 문서 URL |
code | String | body | 성공, 실패 코드 |
message | String | body | 성공, 실패 메시지 |
응답 데이터 예시
{
"result": {
"id": "342c100e7039470f92ebf48ffaec8a74",
"signer": [
{
"index": 1,
"name": "name",
"view_url": "https://doc.signok.com/linkUrl?abcdef"
}
]
},
"code": "200",
"message": "success"
}