문서 생성
개요
템플릿의 서명 영역의 좌표 정보를 이용해 전송된 파일에 서명 영역을 생성한 문서를 생성합니다.
URL
/api/v1/document/create
요청 데이터
| 항목 | 타입 | 위치 | 설명 |
|---|---|---|---|
| document | form-data | body | 문서 |
| template_id | String | body | 템플릿 아이디 |
| title | String | body | 제목 |
| auto_send | Boolean | body | 문서 생성 후 자동 발송 여부 (기본값: false) |
| auto_confirm | Boolean | body | 모든 대상자 서명 후 자동 승인 여부 (기본값: 템플릿 생성 시 부여한 자동승인 값에 따라 변동) |
| signer[] | Array | body | 대상자 배열 |
| index | Integer | body | 대상자 순번 |
| name | String | body | 대상자 이름 |
| String | body | 대상자 이메일 | |
| mobile | String | body | 대상자 휴대폰 |
| item[] | Array | body | 항목 배열 |
| key | String | body | 항목 API Key |
| value | String | body | 항목 값 |
| document_file[] | form-data | body | 파일 |
요청 데이터 예시
POST /api/v1/document/create HTTP/1.1
Host: ***
Authorization: Bearer ACCESS_TOKEN
Content-Length: 1000
Content-Type: multipart/form-data; boundary=----signOKFormBoundary123456789012345
----signOKFormBoundary123456789012345
Content-Disposition: form-data; name="document"
Content-Type: application/json
{
"template_id": "10001",
"title": "문서 제목",
"auto_send": true,
"auto_confirm" : true,
"signer": [
{
"index": 1,
"name": "대상자 이름",
"email": "대상자 이메일"
},
{
"index": 2,
"name": "대상자 이름",
"mobile": "대상자 휴대폰"
}
],
"item": [
{
"key": "항목 API Key",
"value": "항목 값"
},
{
"key": "항목 API Key",
"value": "항목 값"
}
]
}
----signOKFormBoundary123456789012345
Content-Disposition: form-data; name="document_file"; filename="파일명1"
Content-Type: application/pdf
BINARY DATA
----signOKFormBoundary123456789012345
Content-Disposition: form-data; name="document_file"; filename="파일명2"
Content-Type: application/pdf
BINARY DATA
----signOKFormBoundary123456789012345
응답 데이터
| 항목 | 타입 | 위치 | 설명 |
|---|---|---|---|
| document | Object | body | 문서 |
| id | String | body | 문서 아이디 |
| status | String | body | 결과 상태 |
| message | String | body | 결과 메시지 |
성공 응답 데이터 예시
{
"document": {
"id": "10001",
"signer": [
{
"name": "서명자",
"index": "서명자 순서",
"view_url": "서명자 서명페이지"
}
]
}
}
실패 응답 데이터 예시
{
"document": {
"status": "failure",
"message": "실패 메시지"
}
}