문서 생성
개요
템플릿으로부터 문서를 생성합니다.
URL
/api/v1/document/create
요청 데이터
| 항목 | 타입 | 위치 | 설명 |
|---|
| document | Object | 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 | 대상자 이름 |
| email | String | body | 대상자 이메일 |
| mobile | String | body | 대상자 휴대폰 |
| item[] | Array | body | 항목 배열 |
| key | String | body | 항목 API Key |
| value | String | body | 항목 값 |
요청 데이터 예시
{
"document": {
"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": "항목 값"
}
]
}
}
응답 데이터
| 항목 | 타입 | 위치 | 설명 |
|---|
| document | Object | body | 문서 |
| id | String | body | 문서 아이디 |
| status | String | body | 결과 상태 |
| message | String | body | 결과 메시지 |
성공 응답 데이터 예시
{
"document": {
"id": "10001",
"signer": [
{
"name": "서명자",
"index": "서명자 순서",
"view_url": "서명자 서명페이지"
}
]
}
}
실패 응답 데이터 예시
{
"document": {
"status": "failure",
"message": "실패 메시지"
}
}
예제 코드
String requestData = "{\"document\":{\"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\":\"항목 값\"}]}}";
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, requestData);
Request request = new Request.Builder()
.url("https://doc.signok.com/api/v1/document/create")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer ACCESS_TOKEN")
.build();
Response response = client.newCall(request).execute();
var requestData = "{\"document\":{\"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\":\"항목 값\"}]}}";
var client = new RestClient("https://doc.signok.com/api/v1/document/create");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer ACCESS_TOKEN");
request.AddParameter("application/json", requestData, ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
var requestData = "{\"document\":{\"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\":\"항목 값\"}]}}";
var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer ACCESS_TOKEN");
var requestOptions = {
method: "POST",
headers: myHeaders,
body: requestData,
redirect: "follow"
};
fetch("https://doc.signok.com/api/v1/document/create", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log("error", error));
var requestData = "{\"document\":{\"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\":\"항목 값\"}]}}";
var axios = require("axios");
var config = {
method: "POST",
url: "https://doc.signok.com/api/v1/document/create",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer ACCESS_TOKEN"
},
data : requestData
};
axios(config)
.then(function (response) {
console.log(JSON.stringify(response.data));
})
.catch(function (error) {
console.log(error);
});
import http.client
requestData = "{\"document\":{\"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\":\"항목 값\"}]}}"
conn = http.client.HTTPSConnection("doc.signok.com")
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer ACCESS_TOKEN"
}
conn.request("POST", "/api/v1/document/create", requestData, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
