eSign.AIeSign.AI
개발자 센터

서명자 템플릿 컨트롤 세부 정보 가져오기

GET/esignglobal/v1/templates/signerFieldsDetail

인터페이스 설명

템플릿 내 서명자 컨트롤 정보를 조회합니다.

계약 템플릿 번호를 통해templateId템플릿에 설정된 서명자 컨트롤 정보를 가져온 후, 이후 을(를) 사용하여信封(봉투/문서 묶음)을 빠르게 시작할 수 있습니다.인터페이스로信封을 시작합니다.

 

요청 파라미터

파라미터 이름

유형

필수 여부

설명

templateId

string

true

계약 템플릿 ID (SaaS의 템플릿 관리에서 조회 가능  )

요청 예시

GET  https:// … …/esignglobal/v1/templates/signerFieldsDetail?templateId=d288b477-ed3c-4fe6-801c-80d8ec5fe9cf

 

응답 파라미터

파라미터 이름

유형

설명

templateId

string

계약 템플릿 ID

templateName

string

계약 템플릿 이름

documentFieldsarray파일 컨트롤 목록

 

fieldTypestring파일 차원 컨트롤 목록. 지정된 파일에 서명자와 바인딩되지 않은 파일 차원 컨트롤을 추가하는 데 사용됩니다.

 

pageNostring컨트롤 유형. eMeterai를 전달하면 인도네시아 인지세 컨트롤을 나타냅니다.

 

posXfloat컨트롤이 위치한 페이지 번호. 인도네시아 인지세 컨트롤은 단일 페이지만 지정할 수 있으므로 개별 페이지 번호를 전달해야 하며, 1-3 또는 1,3과 같은 연속 또는 비연속 다중 페이지 형식은 지원되지 않습니다.

 

posYfloatx축 오프셋. 페이지의 왼쪽 하단이 좌표 원점입니다. 좌표 범위는 다른 컨트롤의 좌표 범위와 동일합니다.

signerFields

array

템플릿 내 서명자 컨트롤 목록 정보

 

signConfigs

array

서명 컨트롤 정보

 

 

fieldId

string

컨트롤 ID (계약 템플릿 설정 시 eSignGlobal시스템에서 자동 생성)

 

 

fieldKey

string

컨트롤 키 (계약 템플릿 설정 시 사용자가 직접 정의)

 

 

fieldType

string

컨트롤 유형:

signature-서명 영역

stamp-도장 영역

approval-승인 컨트롤

  

required

boolean

필수 입력 여부, 기본값은 필수

true-필수

false-선택

 

 

sizeRule

string

서명 영역 크기 표시 방식

originalSize-서명/도장의 실제 크기에 따라 배치

targetSize-서명/도장 영역의 너비와 높이를 사용자 정의

 

 

height

int

서명 컨트롤 높이

 

 

width

int

서명 컨트롤 너비

 

 

movable

boolean

서명 시 위치 이동 허용

false-서명자가 자신의 서명 컨트롤 위치를 조정할 수 없음

true-서명자가 자신의 서명 컨트롤 위치를 조정할 수 있음

 

 

allowedOptions

array

서명자가 승인할 수 있는 옵션, fieldType이 approval일 때 적용됨. 기본값은 ["approve", "decline"]

approve-동의

decline-거부

 

 

posX

float

컨트롤 위치 X 좌표

 

 

posY

float

컨트롤 위치YY 좌표

 

 

pageNo

string

컨트롤이 있는 페이지 번호

 

fillConfigs

array

서명 컨트롤 정보

 

 

fieldId

string

컨트롤 ID (계약 템플릿 설정 시 시스템에서 자동 생성)eSignGlobal

 

 

fieldKey

string

컨트롤 Key (계약 템플릿 설정 시 사용자가 직접 정의)

 

 

fieldName

string

컨트롤 이름

 

 

required

boolean

필수 입력 여부

true-필수

false-선택

 

 

fieldsType

string

컨트롤 유형:

1-단일 행 텍스트

15-체크박스

 

 

textField

object

텍스트 컨트롤 속성

 

 

 

overflowType

int

text에만 적용됨

1-자동 글자 크기 축소

2-입력 제한

 

 

 

minFontSize

float

text에만 적용되며, overflowType=1인 경우에만 적용됩니다.

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

 

 

 

width

float

컨트롤 너비

 

 

 

fontSize

float

text에만 적용됨, 폰트 크기

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

 

 

 

textColor

string

text에만 적용됨, 16진수 색상

 

 

 

bold

boolean

text에만 적용됨, 폰트 굵기 여부

true-굵게

false-굵지 않음

 

 

 

italic

boolean

text에만 적용됨, 이탤릭체 여부

true-이탤릭체

false-기울임체 아님

 

 

 

underline

boolean

text에만 적용됨, 글자에 밑줄 추가 여부

true-밑줄 추가

false-밑줄 추가 안 함

 

 

 

lineThrough

boolean

text에만 적용됨, 취소선 추가 여부

true-취소선 추가

false-취소선 추가 안 함

 

 

 

horizontalAlignment

string

text에만 적용됨, 수평 가운데 정렬 형식

LEFT-왼쪽 정렬

CENTER-가운데 정렬

RIGHT-오른쪽 정렬

 

 

tickBoxField

object

체크박스 속성

 

 

 

tickOptions

array

Check에만 적용됨

1-체크

2-엑스

 

 

posX

float

컨트롤 위치 X 좌표

 

 

posY

float

컨트롤 위치YY 좌표

 

 

pageNo

string

컨트롤이 있는 페이지 번호

 

signDateConfigs

array

서명 날짜 정보

 

 

fieldId

string

컨트롤 ID (계약 템플릿 설정 시 시스템에서 자동 생성)eSignGlobal

 

 

fieldKey

string

컨트롤 Key (계약 템플릿 설정 시 사용자가 직접 정의)

 

 

movable

boolean

서명 시 위치 이동 허용 여부

false- 서명인이 자신의 서명 컨트롤 위치를 조정할 수 없음

true- 서명인이 자신의 서명 컨트롤 위치를 조정할 수 있음

 

 

posX

float

컨트롤 위치 X 좌표

 

 

posY

float

컨트롤 위치YY 좌표

 

 

pageNo

string

컨트롤이 있는 페이지 번호

 

 

signDateFormat

string

서명 날짜 형식

응답 예시

{
    "code": "0",
    "data": {
        "templateId": "4d61c221270742238d8df2846a1cfd66",
        "templateName": "111111",
        "signerFields": [
            {
                "signConfigs": [
                    {
                        "fieldId": "846d3128e16b4850a06240f94dcf4cf6",
                        "pageNo": "1",
                        "posX": 374.639,
                        "posY": 646.47534,
                        "fieldType": "signature",
                        "movable": false,
                        "height": 60,
                        "width": 150
                    },
                    {
                        "fieldId": "2b00ee28977744b4b22d1b2b020923a7",
                        "pageNo": "1",
                        "posX": 184.99144,
                        "posY": 528.51245,
                        "fieldType": "stamp",
                        "movable": false,
                        "height": 150,
                        "width": 150
                    }
                ],
                "fillConfigs": [
                    {
                        "fieldId": "d450fa4324d943ceaa5bab313f1f9841",
                        "pageNo": "1",
                        "posX": 298.54172,
                        "posY": 569.3938,
                        "fieldType": "1",
                        "fieldName": "单行文本1",
                        "required": true,
                        "textField": {
                            "overflowType": "1",
                            "minFontSize": 8.0,
                            "font": "1",
                            "fontSize": 12.0,
                            "textColor": "#000",
                            "bold": false,
                            "width": 160.0,
                            "italic": false,
                            "underline": false,
                            "lineThrough": false,
                            "horizontalAlignment": "LEFT"
                        }
                    },
                    {
                        "fieldId": "fd216f840c7b4b309ce8bdc23507a98d",
                        "pageNo": "1",
                        "posX": 305.1776,
                        "posY": 535.3552,
                        "fieldType": "15",
                        "fieldName": "勾选1",
                        "required": true,
                        "tickBoxField": {
                            "tickOptions": [
                                1
                            ],
                            "showBorder": true
                        }
                    }
                ],
                "signDateConfigs": [
                    {
                        "fieldId": "a0bf7f9e05f740bfa354596e2462deb5",
                        "pageNo": "1",
                        "posX": 229.48866,
                        "posY": 685.2244,
                        "movable": false,
                        "signDateFormat": "yyyy-MM-dd"
                    }
                ]
            }
        ]
    },
    "message": "success"
}