템플릿 조회
개요
템플릿을 조회합니다.
URL
/api/v1/template/{id}
요청 데이터
항목 | 타입 | 위치 | 설명 |
---|---|---|---|
id | String | query | 템플릿 아이디 |
응답 데이터
항목 | 타입 | 위치 | 설명 |
---|---|---|---|
template | Object | body | 템플릿 목록 배열 |
id | String | body | 템플릿 아이디 |
title | String | body | 제목 |
creator_id | String | body | 생성자 아이디 |
creator_name | String | body | 생성자 이름 |
create_datetime | String | body | 생성 일시 |
item[] | Array | body | 항목 배열 |
id | String | body | 항목 아이디 |
key | String | body | 항목 API Key |
value | String | body | 항목 값 |
type | String | body | 항목구분 |
required | Boolean | body | 항목 필수 여부 |
alias | String | body | 항목 별칭 |
placeholder | String | body | 항목 Place Holder |
signer[] | Array | body | 대상자 배열 |
index | Integer | body | 대상자 순번 |
name | String | body | 대상자 이름 |
String | body | 대상자 이메일 | |
mobile | String | body | 대상자 휴대폰 |
type | String | body | 대상자 구분 |
type_description | String | body | 대상자 구분 설명 |
응답 데이터 예시
{
"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();