post https://docs.esignon.net/api/v3/workflows/start
비대면 타입의 서식을 이용해 문서를 시작합니다.
문서에 대한 서명 또는 작성 요청을 할 때 사용하는 API입니다.
필수 파라미터 안내
필수로 입력해야 하는 파라미터에 대한 설명입니다.
| BODY PARAMS | 설명 |
|---|---|
| workflow_name | 해당 계약서 또는 문서의 이름을 정해주시면 됩니다. |
| template_id | 숫자로 된 서식의 고유 아이디입니다. 이싸인온 서식 메뉴에서 확인할 수 있습니다. |
| order | 작성 단계입니다. 첫번째 단계는 1단계이며, 숫자로 적어주시면 됩니다. |
| 작성자의 이메일 또는 휴대폰 번호를 입력해주시면 됩니다. | |
| name | 작성자의 이름을 입력해주세요. |
휴대폰 본인 인증을 설정하실 경우, 작성자의 이름이 해당 휴대폰 명의와 같아야 합니다.
이싸인온 Field
이싸인온은 여러가지 데이터를 입력할 수 있는 Field를 제공하고 있습니다.
이싸인온 서식에 만들어 둔 필드에 미리 필요한 정보들을 입력하여 시작할 수 있습니다.
- 필드 이름은 이싸인온 서식 내에서 확인 및 수정할 수 있습니다.
필드 별 입력 값 (value) 형식
필드에 입력할 값은 value 형식을 참고하여 입력해주세요.
| field_list | 이싸인온 필드 | Value |
|---|---|---|
| Textbox | 텍스트박스 | 텍스트 값 |
| LabelBox | 텍스트박스 (읽기 전용) | 텍스트 값 |
| RadioBox | 라디오 박스 (단일 선택) | "Y" 또는 "N" |
| CheckBox | 체크박스 (복수 선택) | "Y" 또는 "N" |
| DatePickerBox | 날짜/시간박스 | "YYYY-MM-DD" 형식의 날짜 |
| PictureBox | 사진박스 | 이미지를 base64로 인코딩한 텍스트 값 |
사진박스에 업로드 가능한 이미지 파일 확장자는 jpg, jpeg, png입니다. 다른 확장자 파일을 넣을 경우 문서가 열리지 않을 수 있습니다. 이미지 파일 크기는 1MB를 넘지 않아야 합니다.)
미리보기 URL
is_preview의 값에 따라 URL의 형태가 달라집니다.
| is_preview 값 | URL |
|---|---|
| true | 문서가 시작되지 않고, 미리보기 URL 제공 |
| false | 문서 시작 URL 제공 |
Response token 활용
Response에서 확인할 수 있는 token 값은 문서를 시작한 사람을 기준으로 발급 됩니다.
해당 token 값을 아래 경로 입력하여 상황에 따라 다르게 활용할 수 있습니다.
📌 https://docs.esignon.net/mail/sign?token={token}
- 현재 문서의 진행단계의 작성자와 시작한 사람이 일치하는 경우
- 해당 URL로 서명 가능
- 일치하지 않는 경우
- 해당 URL로 진행 중인 문서 확인 가능
EXPORT API
문서 관련 Webhook 기능이 필요한 경우 EXPORT API 가이드를 참고해주세요.