문서 조회

개요

문서를 조회합니다.

URL

/api/v1/document/{id}

요청 데이터

항목	타입	위치	설명
id	String	query	문서 아이디

응답 데이터

항목	타입	위치	설명
document	Object	body	문서
id	String	body	문서 아이디
title	String	body	제목
creator_id	String	body	생성자 아이디
creator_name	String	body	생성자 이름
create_datetime	String	body	생성 일시
status_description	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	대상자 이름
email	String	body	대상자 이메일
mobile	String	body	대상자 휴대폰
type	String	body	대상자 구분
type_description	String	body	대상자 구분 설명
expire_day	Integer	body	대상자 만료일
view_url	String	body	문서 보기 URL
download_url	String	body	문서 다운로드 URL
history[]	Array	body	문서 이력 배열
index	Integer	body	문서 이력 순번
name	String	body	문서 이력 대상자 이름
email	String	body	문서 이력 대상자 이메일
mobile	String	body	문서 이력 대상자 휴대폰
status_description	String	body	문서 이력 상태 설명
history_datetime	String	body	문서 이력 일시

응답 데이터 예시

{
  "document": {
    "id": "10001",
    "title": "문서 제목",
    "creator_id": "생성자 아이디",
    "creator_name": "생성자 이름",
    "create_datetime": "yyyy-MM-dd HH:mm:ss",
    "status_description": "진행",
    "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": "대상자 구분 설명",
        "expire_day": 7,
        "view_url": "문서 보기 링크",
        "download_url": "문서 다운로드 링크"
      },
      {
        "index": 2,
        "name": "대상자 이름",
        "mobile": "대상자 휴대폰",
        "type": "대상자 구분",
        "expire_day": 7,
        "type_description": "대상자 구분 설명",
        "view_url": "문서 보기 링크",
        "download_url": "문서 다운로드 링크"
      }
    ],
    "history": [
      {
        "index": 1,
        "name": "문서 이력 대상자 이름",
        "email": "문서 이력 대상자 이메일",
        "status_description": "작성중",
        "history_datetime": "yyyy-MM-dd HH:mm:ss"
      },
      {
        "index": 2,
        "name": "문서 이력 대상자 이름",
        "mobile": "문서 이력 대상자 휴대폰",
        "status_description": "진행",
        "history_datetime": "yyyy-MM-dd HH:mm:ss"
      }
    ]
  }
}

예제 코드

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

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

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

var client = new RestClient("https://doc.signok.com/api/v1/document/{id}");
client.Timeout = -1;

var request = new RestRequest(Method.GET);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer ACCESS_TOKEN");
IRestResponse response = client.Execute(request);

Console.WriteLine(response.Content);

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "Bearer ACCESS_TOKEN");

var requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow"
};

fetch("https://doc.signok.com/api/v1/document/{id}", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log("error", error));

var axios = require("axios");

var config = {
  method: "GET",
  url: "https://doc.signok.com/api/v1/document/{id}",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer ACCESS_TOKEN"
  },
};

axios(config)
  .then(function (response) {
    console.log(JSON.stringify(response.data));
  })
  .catch(function (error) {
    console.log(error);
  });

import http.client

requestData = ""

conn = http.client.HTTPSConnection("doc.signok.com")
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer ACCESS_TOKEN"
}

conn.request("GET", "/api/v1/document/{id}", requestData, headers)

res = conn.getresponse()

data = res.read()

print(data.decode("utf-8"))

문서 조회

개요

URL

요청 데이터

응답 데이터

응답 데이터 예시 JSON

예제 코드 Java C# JavaScript Node.js Python

응답 데이터 예시

예제 코드