파라미터 양식 만들기

create-document API를 이용하는 것을 도와주는 API로 템플릿 ID 에 맞는 파라미터 양식을 생성해 줍니다.

파라미터 양식 만들기

POST /rest/api/get-create-document-params

템플릿ID를 받아 문서 생성 API로 전달할 파라미터를 생성해주는 API

templateId(*) 또는 templateIds(*) 중 하나의 값은 반드시 전달해주어야 합니다.

templateId, templateIds 모두 전달하는 경우 templateId가 우선 시 됩니다.

Headers

Name	Type	Description
apikey*	String	발급된 api key

Request Body

Name	Type	Description
templateId (conditinally required)	Number | String	사용할 템플릿 아이디
templateIds (conditinally required)	String	사용할 템플릿 아이디 목록 comma로 구분됨 예시) "templateIds":"10,11"
contentMappedByElementName	boolean	파라미터 매핑 시 순서와 상관없이 element 이름으로만 매핑하는 옵션

Response Example

200: OK 성공 또는 핸들링된 오류

Example1

{
    "templateId": 25,               // 문서 생성 시 사용할 템플릿 번호
    "name": "",                     // 생성될 문서의 이름
    "message": "",                  // 서명자가 문서 서명화면을 열 때 표시되는 알림 문구
    "expiredDays": 7,               // 문서 생성 후 서명 가능한 유효기간, 1 = 1일
    "tagData": "",                  // 문서 조회 시 이용 가능한 태그 정보, ","로 구분하며 최대 10개까지 가능
    "userPassword": null,           // 서명하기 화면에서 사용자가 인증하는 암호
    "password": null,               // 완료 시 문서를 확인하기 위해 필요한 암호
    "groupNameSend": false,         // 발송을 하는 경우 발송자가 싸인투게더에서 해당 그룹명이 되도록 함.
    "docSecurity": false,           // 완료된 문서의 암호를 설정하도록 한다. false면 위에 설정한 암호가 의미 없음
    "userSecurity": false,          // 서명하기 화면에서 사용자에게 암호를 묻도록 한다.
    "transferType": 0,              // 문서 생성 시 알림을 보내거나 보내지 않는다 0 = 안 보낸다, null or "" 보낸다.
    "contractors": [                // 서명을 하는 사람 정보
    {
      "name": "",                   // 서명자의 이름
      "contact": "",                // 서명자의 연락처(전화번호 or 이메일)
      "phone": "",                  // 서명자의 전화번호, 본인인증이 활성화 되는 경우 해당 번호를 이용하여 인증
      "companyName": "",            // 법인인증이 활성화일때(companyCert = true) 전달해야하는 법인명
      "companyRegNo": ""            // 법인인증이 활성화일때(companyCert = true) 전달해야하는 법인 사업자 번호
    }],
    "companyCert": false,           // 법인 인증서 적용 여부
    "noOrder": false,               // 서명자가 여러명인 경우 해당 값이 true이면 서명 순서를 무시(false로 사용할 것)
    "mobileCert": false,            // 본인 인증 여부   
    "mobileCertOption": "Default",  // 모바일 인증 시 옵션 설정 (모달인지 아닌지, 휴대전화인증인지 통합인증인지)
    "contentMappedByElementName":false, //  파라미터 매핑 시 순서/seq를 지킴
    "attachSecurity": false,        // 첨부파일이 있는 경우, 서명 완료 전 서명자가 첨부파일을 볼 수 있도록  한다.
    "participantPassword": false,   // 해당 값이 true이면 서명 하기 화면에서 암호를 묻는다. 
    "hideConsenseMessage": true,    // 서명 화면에서 완료 시 싸인투게더 약관을 숨긴다.
    "hideRefuseButton": false,      // 해당 값이 true이면 서명하기 화면에서 거절버튼을 숨긴다.
    "hideButtonAtComplete": false,  // 해당 값이 true이면, 계약(문서)완료 시점에 체험하기 버튼, 로그인 링크 숨김
    "signpadOption": "Default",     // 서명 패드 옵션 
    "useUpdateAllSign": true,       // 해당 값이 true이면 서명하기 화면에서 서명란에 대해서 일괄 업데이트 허용
    "allPagesReadRequired" :false,  // 해당 값이 true이면 참여는 모든 페이지를 확인해야 계약 완료 가능
    "content": {                    // 각 페이지별 서명 요청자가 입력하는 정보
      "page_1": {                   // 첫번째 페이지 (page_1, page_2, ..., page_n)
        "text_1_elementName": "문자열 입력",     // 템플릿 1page, 첫번째 콤포넌트, 타입은 textbox를 의미
        "check_2_elementName": "true",          // 템플릿 1page, 두번째 콤포넌트, 타입은 checkbox를 의미
        "datebox_3_elementName": "2023-09-01"   // 템플릿 1page, 세번째 콤포넌트, 타입은 datebox를 의미
        "addressbox_4_elementName" : {          // 템플릿 1page, 네번째 콤포넌트, 타입은 addressbox를 의미 (JsonObject)
          "zipCode": "",       // 우편번호
          "address": "",       // 주소
          "addressDetail": ""  // 상세주소
        }
      }, 
      "page_2": {                    // 두번째 페이지
        "text_1_elementName": "문자열 입력",      // 템플릿 2page, 첫번째 콤포넌트, 타입은 textbox를 의미
        "text_2_elementName": "문자열 입력"       // 템플릿 2page, 두번째 콤포넌트, 타입은 textbox를 의미
      }
    }
  }

Example2

{
    "templateId": 25,               // 문서 생성 시 사용할 템플릿 번호
    "name": "",                     // 생성될 문서의 이름
    "message": "",                  // 서명자가 문서 서명화면을 열 때 표시되는 알림 문구
    "expiredDays": 7,               // 문서 생성 후 서명 가능한 유효기간, 1 = 1일
    "tagData": "",                  // 문서 조회 시 이용 가능한 태그 정보, ","로 구분하며 최대 10개까지 가능
    "userPassword": null,           // 서명하기 화면에서 사용자가 인증하는 암호
    "password": null,               // 완료 시 문서를 확인하기 위해 필요한 암호
    "groupNameSend": false,         // 발송을 하는 경우 발송자가 싸인투게더에서 해당 그룹명이 되도록 함.
    "docSecurity": false,           // 완료된 문서의 암호를 설정하도록 한다. false면 위에 설정한 암호가 의미 없음
    "userSecurity": false,          // 서명하기 화면에서 사용자에게 암호를 묻도록 한다.
    "transferType": 0,              // 문서 생성 시 알림을 보내거나 보내지 않는다 0 = 안 보낸다, null or "" 보낸다.
    "contractors": [                // 서명을 하는 사람 정보
    {
      "name": "",                   // 서명자의 이름
      "contact": "",                // 서명자의 연락처(전화번호 or 이메일)
      "phone": "",                  // 서명자의 전화번호, 본인인증이 활성화 되는 경우 해당 번호를 이용하여 인증
      "companyName": "",            // 법인인증이 활성화일때(companyCert = true) 전달해야하는 법인명
      "companyRegNo": ""            // 법인인증이 활성화일때(companyCert = true) 전달해야하는 법인 사업자 번호
    }],
    "companyCert": false,           // 법인 인증서 적용 여부
    "noOrder": false,               // 서명자가 여러명인 경우 해당 값이 true이면 서명 순서를 무시(false로 사용할 것)
    "mobileCert": false,            // 본인 인증 여부
    "mobileCertOption": "Default",  // 모바일 인증 시 옵션 설정 (모달인지 아닌지, 휴대전화인증인지 통합인증인지)
    "contentMappedByElementName": true  // 파라미터 매핑 시 순서/seq를 지키지 않음
    "attachSecurity": false,        // 첨부파일이 있는 경우, 서명 완료 전 서명자가 첨부파일을 볼 수 있도록  한다.
    "participantPassword": false,   // 해당 값이 true이면 서명하기 화면에서 암호를 묻는다. 
    "hideConsenseMessage": true,    // 서명 화면에서 완료 시 싸인투게더 약관을 숨긴다.
    "hideRefuseButton": false,      // 해당 값이 true이면 서명하기 화면에서 거절버튼을 숨긴다.   
    "hideButtonAtComplete": false,  // 해당 값이 true이면, 계약(문서)완료 시점에 체험하기 버튼, 로그인 링크 숨김
    "signpadOption": "Default",     // 서명 패드 옵션 
    "useUpdateAllSign": true,       // 해당 값이 true이면 서명하기 화면에서 서명란에 대해서 일괄 업데이트 허용
    "content": {                    // 각 페이지별 서명 요청자가 입력하는 정보
      "page_1": {                   // 첫번째 페이지 (page_1, page_2, ..., page_n)
        "elementA": "문자열 입력",    // 템플릿 1page, elementName이 elementA인 모든 컴포넌트에 적용됨
        "chkElement": "true",       // 템플릿 1page, elementName이 chkElement인 모든 컴포넌트에 적용됨
      }, 
      "page_2": {                   // 두번째 페이지
        "textA": "문자열 입력",       // 템플릿 2page, elementName이 textA인 모든 컴포넌트에 적용됨
        "textB": "문자열 입력"        // 템플릿 2page, elementName이 textB인 모든 컴포넌트에 적용됨
      }
    }
  }

Example3

{
    "templateIds": "10,20",         // 문서 생성 시 사용할 템플릿 번호 목록
    "name": "",                     // 생성될 문서의 이름
    "message": "",                  // 서명자가 문서 서명화면을 열 때 표시되는 알림 문구
    "expiredDays": 7,               // 문서 생성 후 서명 가능한 유효기간, 1 = 1일
    "tagData": "",                  // 문서 조회 시 이용 가능한 태그 정보, ","로 구분하며 최대 10개까지 가능
    "userPassword": null,           // 서명하기 화면에서 사용자가 인증하는 암호
    "password": null,               // 완료 시 문서를 확인하기 위해 필요한 암호
    "groupNameSend": false,         // 발송을 하는 경우 발송자가 싸인투게더에서 해당 그룹명이 되도록 함.
    "docSecurity": false,           // 완료된 문서의 암호를 설정하도록 한다. false면 위에 설정한 암호가 의미 없음
    "userSecurity": false,          // 서명하기 화면에서 사용자에게 암호를 묻도록 한다.
    "transferType": 0,              // 문서 생성 시 알림을 보내거나 보내지 않는다 0 = 안 보낸다, null or "" 보낸다.
    "contractors": [                // 서명을 하는 사람 정보
    {
      "name": "",                   // 서명자의 이름
      "contact": "",                // 서명자의 연락처(전화번호 or 이메일)
      "phone": "",                  // 서명자의 전화번호, 본인인증이 활성화 되는 경우 해당 번호를 이용하여 인증
      "companyName": "",            // 법인인증이 활성화일때(companyCert = true) 전달해야하는 법인명
      "companyRegNo": ""            // 법인인증이 활성화일때(companyCert = true) 전달해야하는 법인 사업자 번호
    }],
    "companyCert": false,           // 법인 인증서 적용 여부
    "noOrder": false,               // 서명자가 여러명인 경우 해당 값이 true이면 서명 순서를 무시(false로 사용할 것)
    "mobileCert": false,            // 본인 인증 여부
    "mobileCertOption": "Default",  // 모바일 인증 시 옵션 설정 (모달인지 아닌지, 휴대전화인증인지 통합인증인지)
    "contentMappedByElementName": true  // 파라미터 매핑 시 순서/seq를 지키지 않음
    "attachSecurity": false,        // 첨부파일이 있는 경우, 서명 완료 전 서명자가 첨부파일을 볼 수 있도록  한다.
    "participantPassword": false,   // 해당 값이 true이면 서명하기 화면에서 암호를 묻는다. 
    "hideConsenseMessage": true,    // 서명 화면에서 완료 시 싸인투게더 약관을 숨긴다.
    "hideRefuseButton": false,      // 해당 값이 true이면 서명하기 화면에서 거절버튼을 숨긴다.   
    "hideButtonAtComplete": false,  // 해당 값이 true이면, 계약(문서)완료 시점에 체험하기 버튼, 로그인 링크 숨김
    "signpadOption": "Default",     // 서명 패드 옵션 
    "useUpdateAllSign": true,       // 해당 값이 true이면 서명하기 화면에서 서명란에 대해서 일괄 업데이트 허용
    "content": {                    // 각 페이지별 서명 요청자가 입력하는 정보
      "page_1": {                   // 첫번째 페이지 (page_1, page_2, ..., page_n)
        "elementA": "문자열 입력",    // 템플릿 1page, elementName이 elementA인 모든 컴포넌트에 적용됨
        "chkElement": "true",       // 템플릿 1page, elementName이 chkElement인 모든 컴포넌트에 적용됨
      }, 
      "page_2": {                   // 두번째 페이지
        "textA": "문자열 입력",       // 템플릿 2page, elementName이 textA인 모든 컴포넌트에 적용됨
        "textB": "문자열 입력"        // 템플릿 2page, elementName이 textB인 모든 컴포넌트에 적용됨
      }
    }
  }

type

json

400: Bad Request 핸들링 하지 못한 오류에 대한 처리

Example

{
  "timestamp": "2023-09-01T14:27:27.971+00:00",
  "status": 400,
  "error": "Bad Request",
  "message": "[|COM_002]Invalid_Parameter|파라미터 정보가 정상적이지 않습니다.",
  "path": "/rest/get-create-document-params"
}

401: Unauthorized keyauth 토큰(apikey)이 잘못된 경우

Example

{
    "message": "Bad token; invalid JSON"
}

401: Unauthorized Header에 apikey를 전달하지 않은 경우

Example

{
    "message": "Unauthorized"
}