Skip to main content Link Menu Expand (external link) Document Search Copy Copied

템플릿 조회

개요

템플릿을 조회합니다.


URL

/api/v1/template/{id}

요청 데이터

항목타입위치설명
idStringquery템플릿 아이디

응답 데이터

항목타입위치설명
templateObjectbody템플릿 목록 배열
idStringbody템플릿 아이디
titleStringbody제목
creator_idStringbody생성자 아이디
creator_nameStringbody생성자 이름
create_datetimeStringbody생성 일시
item[]Arraybody항목 배열
idStringbody항목 아이디
keyStringbody항목 API Key
valueStringbody항목 값
typeStringbody항목구분
requiredBooleanbody항목 필수 여부
aliasStringbody항목 별칭
placeholderStringbody항목 Place Holder
signer[]Arraybody대상자 배열
indexIntegerbody대상자 순번
nameStringbody대상자 이름
emailStringbody대상자 이메일
mobileStringbody대상자 휴대폰
typeStringbody대상자 구분
type_descriptionStringbody대상자 구분 설명

응답 데이터 예시

{
  "template": {
    "id": "10001",
    "title": "템플릿 제목",
    "creator_id": "생성자 아이디",
    "creator_name": "생성자 이름",
    "create_datetime": "yyyy-MM-dd HH:mm:ss",
    "item": [
      {
        "id": "항목 아이디",
        "key": "항목 API Key",
        "value": "항목 값",
        "type": "항목 구분",
        "required": true,
        "alias": "항목 별칭",
        "placeholder": "항목 Place Holder"
      },
      {
        "id": "항목 아이디",
        "key": "항목 API Key",
        "value": "항목 값",
        "type": "항목 구분",
        "required": true,
        "alias": "항목 별칭",
        "placeholder": "항목 Place Holder"
      }
    ],
    "signer": [
      {
        "index": 1,
        "name": "대상자 이름",
        "email": "대상자 이메일",
        "type": "대상자 구분",
        "type_description": "대상자 구분 설명"
      },
      {
        "index": 2,
        "name": "대상자 이름",
        "mobile": "대상자 휴대폰",
        "type": "대상자 구분",
        "type_description": "대상자 구분 설명"
      }
    ]
  }
}

예제 코드

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();

Request request = new Request.Builder()
  .url("https://doc.signok.com/api/v1/template/{id}")
  .method("GET", null)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer ACCESS_TOKEN")
  .build();

Response response = client.newCall(request).execute();

Back to top

COPYRIGHT (C) 2022 KICA INC. ALL RIGHTS RESERVED