eformsign API 사용하기

eformsign이 제공하는 API를 사용해 eformsign의 기능을 고객의 시스템/서비스에서 호출해 사용할 수 있습니다.

시작하기

eformsign API를 사용하기 위해서는 다음의 준비 작업이 필요합니다.

  • 회사 ID와 문서 ID 확인하기

  • API 키 발급 및 비밀키 확인하기

  • 서명 생성하기

Caution

서명 생성에는 30초의 시간 제한이 있습니다. 30초 이내에 서명을 생성하고 토큰을 발급받아야 합니다.

회사 ID와 문서 ID 확인하기

eformsign API를 사용하기 위해서는 소속 회사의 ID와 조회하고자 하는 문서의 ID를 알고 있어야 합니다.

eformsign 서비스에 로그인하여 회사 ID와 문서 ID를 확인해 주세요.

Note

회사 ID는 회사 관리 > 회사 정보 메뉴의 기본 정보 탭에서 확인할 수 있습니다.

image1

문서 ID는 각 문서함 오른쪽 상단의 문서 아이콘(image2)을 클릭하여 문서 ID 컬럼을 추가하면 조회하고자 하는 문서의 ID를 확인할 수 있습니다.

image3

API 키 발급 및 비밀키 확인하기

Note

API 키는 대표 관리자만 발급할 수 있습니다. 대표 관리자가 아닌 경우, API 키 필요 시 대표 관리자에게 요청하시기 바랍니다.

  1. 메뉴에서 [커넥트] > [API / Webhook] 클릭하여 이동한 후 API 키 생성 버튼을 클릭합니다.

커넥트 > API/Webhook 메뉴 위치
  1. API 키 생성 팝업창에 별칭애플리케이션 이름을 입력합니다.

API 키 생성 팝업창
  1. 검증 유형을 선택 후 저장합니다.

Note

검증 유형은 Bearer token, Basic authentication, eformsign signature 중에서 선택할 수 있습니다.

  • Bearer Token: 검증을 위해 사전 설정한 값을 이용하는 방식입니다.

API 키 생성 팝업창1

검증 유형을 Bearer token으로 선택하고 토큰값으로 사용할 값을 란에 입력 후 저장합니다. Access Token 발급 시 요청 헤더 eformsign_signature에 해당 토큰값을 Bearer 토큰값 형태로 입력합니다. 다음 예제를 참고해 주세요.

curl --location --request POST 'https://service.eformsign.com/v2.0/api_auth/access_token' \
--header 'eformsign_signature: Bearer {토큰값}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {base64 encoded api key }' \
--data-raw '{
 "execution_time":{현재시간ms},
 "member_id": {eformsign 계정}
}'
  • Basic Authentication: 검증을 위해 아이디와 비밀번호를 이용하는 방식입니다.

API 키 생성 팝업창2

검증 유형을 Basic authentication으로 선택하고 사용할 아이디와 비밀번호를 입력 후 저장합니다. Access Token 발급 시 요청 헤더 eformsign_signature에 아이디:비밀번호 형태로 Base64 인코딩한 값을 입력합니다. 다음 예제를 참고해 주세요.

curl --location --request POST 'https://service.eformsign.com/v2.0/api_auth/access_token' \
--header 'eformsign_signature: Basic {base64 encoded "id:password"}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {base64 encoded api key }' \
--data-raw '{
 "execution_time":{현재시간ms},
 "member_id": {eformsign 계정}
}'
  • eformsign Signature: 검증을 위해 eformsign Signature 서명값을 이용하는 방식입니다. 검증 유형을 eformsign signature로 선택한 후 저장합니다. eformsign Signature로 서명 생성하는 방법은 서명 생성하기를 참고해 주세요.

  1. 생성된 키 목록에서 키보기 버튼을 클릭하여 API 키와 비밀키를 확인합니다.

API 키보기 버튼 위치 API 키 및 비밀키 확인

Note

API 키 수정 방법

생성된 키 목록에서 수정 버튼을 클릭하면 별칭과 어플리케이션 이름을 수정할 수 있습니다. 또한, 상태 영역을 클릭하여 활성/비활성 상태로 변경할 수도 있습니다.

Note

API 키 삭제 방법

생성된 키 목록에서 삭제 버튼을 클릭하여 API 키를 삭제할 수 있습니다.

서명 생성하기

API 사용을 위한 토큰을 발급받기 위해서는 먼저 eformsign_signature라는 서명을 생성해야 합니다. eformsign_signature는 비대칭 키 방식과 타원곡선 암호화(Elliptic curve cryptography)를 사용하고 있습니다. 서버의 현재 시간을 String(UTF-8)으로 변환하고, API Key 발급하기에서 발급받은 비밀키(Private key)로 서명한 후, 서명한 데이터를 hex string으로 변환하는 방법으로 서명을 생성할 수 있습니다.

Tip

타원곡선 암호화는 공개키 암호화 방식 중 하나로, 데이터 암호화 디지털 인증 등 현재 가장 많이 쓰이는 암호방식입니다.

Note

서명 알고리즘은 SHA256withECDSA을 사용합니다.

서명 생성 방법에 대해서 Java, JavaScript (Node.js), Python, PHP 언어별로 설명합니다.

Java

Java 예제에서는 서명 생성을 위해 java.security 패키지를 사용합니다.

Javascript(Node.JS)

Jsrsasign(https://kjur.github.io/jsrsasign/) npm 종속성이 설치되어 있어야 합니다.

npm install jsrsasign

Python

별도의 키 포맷 처리용 라이브러리를 사용해야 합니다. 작업전 다음의 명령어를 통해 해당 라이브러리를 설치해 주세요.

pip install https://github.com/warner/python-ecdsa/archive/master.zip

PHP

PHP 예제를 사용하려면 PHP OpenSSL 라이브러리가 설치되어 있어야 하며, 다음 예제의 keycheck.inc.php, test.php 파일이 동일한 경로에 위치하게 한 후에 진행해야 합니다.

C# (.NET)

암호화 관련 처리를 위해 BouncyCastle 라이브러리를 설치해야 합니다. (NuGet 패키지로도 설치 가능, MIT License)

각 언어별 예제

다음은 각 언어별 예제입니다.

Note

execution_time은 long 타입을 사용합니다. 따라서, execution_time 입력 시에는 Access Token 발급 시에 확인한 시간 뒤에 L을 넣어 입력합니다.

Note

서명을 생성하기 위해서는 비밀키가 필요합니다. 비밀키 확인하는 방법은 API Key 발급 및 비밀키 확인하기를 참고해 주세요.

  • Java
  • Javascript(Node.JS)
  • Python
  • PHP - keycheck.inc.php
  • PHP - test.php
  • C#(.NET) - Program.cs
import java.security.KeyFactory;
import java.security.spec.PKCS8EncodedKeySpec;
import java.security.PrivateKey;
import java.security.Signature;

//private key
String privateKeyHexStr = "이 곳에 발급받은 비밀키 입력(String 형태)";
KeyFactory keyFact = KeyFactory.getInstance("EC");
PKCS8EncodedKeySpec psks8KeySpec = new PKCS8EncodedKeySpec(new BigInteger(privateKeyHexStr,16).toByteArray());
PrivateKey privateKey = keyFact.generatePrivate(psks8KeySpec);

//execution_time - 서버 현재 시간
long execution_time = new Date().getTime();
// long execution_time = 1611537340731L;     //직접 입력 시 long 값이기 때문에 숫자 뒤에 L 추가
String execution_time_str = String.valueOf(execution_time);

//eformsign_signature 생성
Signature ecdsa = Signature.getInstance("SHA256withECDSA");
ecdsa.initSign(privateKey);
ecdsa.update(execution_time_str.getBytes("UTF-8"));
String eformsign_signature = new BigInteger(ecdsa.sign()).toString(16);


//현재 시간 및 현재 시간 서명값
System.out.print("execution_time : "+execution_time);
System.out.print("eformsign_signature : "+eformsign_signature);
const rs = require('jsrsasign');


// User-Data-Here
const execution_time  = Date.now()+"";
const privateKeyHex = "발급받은 비밀키 입력(String 형태)";

// User-Data-Here
var privateKey = rs.KEYUTIL.getKeyFromPlainPrivatePKCS8Hex(privateKeyHex);

// Sign
var s_sig = new rs.Signature({alg: 'SHA256withECDSA'});
s_sig.init(privateKey);
s_sig.updateString(execution_time);
var signature = s_sig.sign();
console.log('data:', execution_time);
console.log('eformsign_signature:', signature);
import hashlib
import binascii

from time import time
from ecdsa import SigningKey, VerifyingKey, BadSignatureError
from ecdsa.util import sigencode_der, sigdecode_der

# private key
privateKeyHex = "발급받은 비밀키 입력(String 형태)"
privateKey = SigningKey.from_der(binascii.unhexlify(privateKeyHex))

# execution_time - 서버 현재 시간
execution_time_int = int(time() * 1000)
execution_time = str(execution_time_int)

# eformsign_signature 생성
eformsign_signature = privateKey.sign(execution_time.encode('utf-8'), hashfunc=hashlib.sha256, sigencode=sigencode_der)

# 현재 시간 및 현재 시간 서명값
print("execution_time : " + execution_time)
print("eformsign_signature : " + binascii.hexlify(eformsign_signature).decode('utf-8'))
<?php
namespace eformsignECDSA;

class PublicKey
{

    function __construct($str)
    {
        $pem_data = base64_encode(hex2bin($str));
        $offset = 0;
        $pem = "-----BEGIN PUBLIC KEY-----\n";
        while ($offset < strlen($pem_data)) {
            $pem = $pem . substr($pem_data, $offset, 64) . "\n";
            $offset = $offset + 64;
        }
        $pem = $pem . "-----END PUBLIC KEY-----\n";
        $this->openSslPublicKey = openssl_get_publickey($pem);
    }
}

class PrivateKey
{

    function __construct($str)
    {
        $pem_data = base64_encode(hex2bin($str));
        $offset = 0;
        $pem = "-----BEGIN EC PRIVATE KEY-----\n";
        while ($offset < strlen($pem_data)) {
            $pem = $pem . substr($pem_data, $offset, 64) . "\n";
            $offset = $offset + 64;
        }
        $pem = $pem . "-----END EC PRIVATE KEY-----\n";
        $this->openSslPrivateKey = openssl_get_privatekey($pem);
    }
}


function getNowMillisecond()
{
  list($microtime,$timestamp) = explode(' ',microtime());
  $time = $timestamp.substr($microtime, 2, 3);

  return $time;
}


function Sign($message, $privateKey)
{
    openssl_sign($message, $signature, $privateKey->openSslPrivateKey, OPENSSL_ALGO_SHA256);
    return $signature;
}
?>
<?php
require_once __DIR__ . '/keycheck.inc.php';

use eformsignECDSA\PrivateKey;


define('PRIVATE_KEY', '발급받은 비밀키 입력(String 형태)');


//private key 세팅
$privateKey = new PrivateKey(PRIVATE_KEY);


//execution_time - 서버 현재 시간
$execution_time = eformsignECDSA\getNowMillisecond();


//eformsign_signature 생성
$signature = eformsignECDSA\Sign($execution_time, $privateKey);


//현재 시간 및 현재 시간 서명값
print 'execution_time : ' . $execution_time . PHP_EOL;
print 'eformsign_signature : ' . bin2hex($signature) . PHP_EOL;
?>
using System;
using System.Text;
using Org.BouncyCastle.Crypto;
using Org.BouncyCastle.Security;
using Org.BouncyCastle.Crypto.Parameters;


namespace eformsign_signature
{
    class Program
    {
        private static readonly string HASH_ENCRYPTION_ALGORITHM = "SHA256withECDSA";


        static void Main(string[] args)
        {
            byte[] privateKeyBytes = HexStringToByteArray("이 곳에 발급받은 비밀키 입력(String 형태)");

            DateTime unixEpoch = new DateTime(1970, 1, 1);
            DateTime currentTime = DateTime.UtcNow;
            TimeSpan timeDiff = currentTime.Subtract(unixEpoch);
            long unixCurrentTime = (long)timeDiff.TotalMilliseconds;
            string execution_time = unixCurrentTime.ToString();


            ISigner signer = SignerUtilities.GetSigner("SHA256withECDSA");
            signer.Init(true, (ECPrivateKeyParameters)PrivateKeyFactory.CreateKey(privateKeyBytes));


            byte[] dataBytes = Encoding.UTF8.GetBytes(execution_time);


            signer.BlockUpdate(dataBytes, 0, dataBytes.Length);
            byte[] signatureBytes = signer.GenerateSignature();


            Console.WriteLine("execution_time : {0}", execution_time);
            Console.WriteLine("eformsign_signature : {0}", ByteArrayToHexString(signatureBytes));
        }


        public static string ByteArrayToHexString(byte[] data)
        {
            StringBuilder builder = new StringBuilder();
            for (int i = 0; i < data.Length; i++)
            {
                builder.Append(data[i].ToString("x2"));
            }
            return builder.ToString();
        }


        public static byte[] HexStringToByteArray(string hexString)
        {
            if (hexString.Length % 2 != 0)
            {
                throw new ArgumentException("{0} must have an even length", nameof(hexString));
            }
            byte[] bytes = new byte[hexString.Length / 2];
            for (int i = 0; i < bytes.Length; i++)
            {
                string currentHex = hexString.Substring(i * 2, 2);
                bytes[i] = Convert.ToByte(currentHex, 16);
            }
            return bytes;
        }
    }
}

API 제공 리스트

eformsign API는 토큰 발급 및 갱신을 위한 API와 문서 작성 및 처리를 위한 API, 멤버 및 그룹 관리 API로 구분되어 있습니다.

토큰 발급 및 갱신을 위한 API

API 사용을 위해서는 우선 Access Token을 발급받아야 합니다. 발급받은 토큰에는 유효기간이 있으며, 유효기간 경과 후에는 갱신 혹은 재발급이 필요합니다.

토큰 발급

API Key로 Access Token을 발급 받는 API입니다.

POST: Access Token 발급

Access Token API에 대한 자세한 설명은 다음에서 확인하실 수 있습니다.

Note

토큰 발급을 위해서는 다음의 내용을 각각 입력해 주세요.

  • Authorize: 이폼사인에서 발급받은 API 키를 Base64로 인코딩한 값 입력

  • Header: 생성한 서명값(eformsign_signature) (* 참고: API 키 발급 시 설정한 검증유형에 따라 다름)

  • Request body: 서명 생성 시간(execution_time)과 계정 ID(member_id) 입력

image5

멤버 정보 없이 토큰을 발급할 수도 있습니다. 이 경우, 서명 생성 시간(execution_time)만 Request body에 입력하시면 됩니다. 단, 이 토큰으로는 새 문서 작성 등 멤버 정보가 필요한 API는 이용하실 수 없습니다.

image6

필요한 값 입력 후 해당 API를 호출하면 Access Token이 발급되며, 다음과 같은 형태의 응답을 수신할 수 있습니다. API 이용에 필요한 oauth_token.access_token, 토큰 갱신에 필요한 oauth_token.refresh_token, 토큰의 유효시간을 나타내는 oauth_token.expires_in, API 호출 서버를 나타내는 api_key.company.api_url을 확인해 주세요.

{ "api_key": { "name": "애플리케이션_", "alias": "테스트용", "company": { "company_id": "dec5418e58694d90a65d6c38e3d226db", "name": "샘플 데모", "api_url": "https://kr-api.eformsign.com" } }, "oauth_token": { "expires_in": 3600, "token_type": "JWT", "refresh_token": "8fd0a3c1-44dc-4a03-96ad-01fa34cd159c", "access_token": "eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJlZm9ybXNpZ24uaWFtIiwiY29udGV4dCI6eyJjbGllbnRJZCI6IjY4MDk0ZWVhMjVhZjRhNjI5ZTI4ZGU5Y2ZlYzRlYmZjIiwiY2xpZW50S2V5IjoiZTNiM2IzZTUtMGEzMS00NTE1LWE5NzEtN2M4Y2FlNDI4NzZmIiwibWFuYWdlbWVudElkIjoiMzRhYWI4MDBjMmEwNDQwNThmZDRlZjc5OGFlY2RlY2EiLCJzY29wZXMiOiJzbWFydF9lZm9ybV9zY29wZSIsInR5cGUiOiJ1c2VyIiwidXNlck5hbWUiOiIzMmIzZDRmOC00MjdkLTRjZjQtOTZiYS1mYzAxNjIxNWRkNDciLCJ1c2VySWQiOiJhNTEyNGVkNmU2M2Y0OTMzOGJlOTA0MjVhNjFkYjlmNSIsInJlZnJlc2hUb2tlbiI6IjhmZDBhM2MxLTQ0ZGMtNGEwMy05NmFkLTAxZmEzNGNkMTU5YyJ9LCJjbGFpbSI6eyJjb21wYW55X2lkIjoiZGVjNTQxOGU1ODY5NGQ5MGE2NWQ2YzM4ZTNkMjI2ZGIiLCJhY2Nlc3Nfa2V5IjoiMzJiM2Q0ZjgtNDI3ZC00Y2Y0LTk2YmEtZmMwMTYyMTVkZDQ3In0sImV4cCI6MTYxMTU0MjIzNiwiaWF0IjoxNjExNTM4NjM2fQ.BltoXXBSabjXfpyLsZik9OZTE5XtLqe9lguMmJ_qfwZN1NyoVoxDqA5y1-_TLis7FvvNjfI1eegOroCZDZPFyXRaBxAj0CW8TijVjbhliJBuccHFyKXaJxmo_GMmTHYtxNNB1SUgLeFIrYROnpQndU8J7ZkfPDgYGwh1YSx-5s4" } }

Caution

토큰 생성에는 30초의 시간 제한이 있습니다. 서명 생성 시간으로부터 30초 이내에 토큰을 발급받아야 합니다. 30초가 경과하였거나, 서버 상의 시간과 현재 시간이 일치하지 않는 경우 다음과 같은 응답이 수신됩니다. 수신한 응답 메시지의 “execution_time”을 확인하세요.

{ "code": "4000002", "ErrorMessage": "The validation time has expired.",     "execution_time": 1611538409405 }

토큰 갱신

토큰의 유효시간은 현재 3600초(1시간)으로 설정되어 있습니다. 토큰의 유효시간이 만료되면 더 이상 해당 토큰으로 API를 이용할 수 없습니다. 다음 API를 사용해 토큰을 갱신해 주세요.

POST: Access Token 갱신

Note

토큰 갱신을 위해서는 Access Token을 Authorize에, Refresh Token을 Query에 입력하셔야 합니다.

Caution

토큰 만료 후 오랜 시간이 지난 경우, refresh_token이 유효하지 않다는 응답이 수신될 수 있습니다. 이 경우, Access Token 발급 API를 통해 토큰을 새로 발급 받아주세요.


문서 작성 및 처리를 위한 API

서명을 생성한 후에는 다음의 문서 API를 사용해 새 문서를 작성하거나 문서 정보를 조회할 수 있으며, 완료 문서 파일(문서 PDF, 감사추적증명서) 다운로드하거나 문서의 첨부파일을 다운로드할 수 있습니다.

Caution

본 문서 API를 사용하기 위해서는 Access Token을 먼저 발급받아야 합니다. Access Token API로 발급받은 Access Token을 다음의 위치에 있는 Authorize 버튼(image4)을 눌러 등록하세요.

Note

문서 API의 Authorize 버튼에는 Access Token 값을 입력해야 합니다.

현재 제공 중인 문서 API는 다음과 같습니다.

POST: 새 문서 작성_최초 작성자가 회사 멤버

회사 멤버가 템플릿으로 문서를 한 건 작성합니다.

POST: 새 문서 작성_최초 작성자가 외부 수신자

회사 멤버가 아닌 사용자가 문서를 한 건 작성합니다. 템플릿 설정>워크플로우 설정의 시작 단계 속성에서 URL로 문서 작성 허용이 체크되어 있는 템플릿만 사용할 수 있습니다.

GET: 문서 정보 조회

특정 문서의 일반 정보, 상세 정보, 이력, 진행 상황 등을 조회합니다.

GET: 문서 파일 다운로드_문서 PDF 및 감사추적증명서

문서 파일 및 감사추적증명서 파일을 PDF 형태로 다운로드합니다.

GET: 문서 첨부 파일 다운로드

문서에 첨부된 파일을 다운로드합니다.

GET: 문서 목록 조회

문서함의 문서 목록을 조회하고, 각 문서의 일반 정보, 상세 정보, 이력, 진행상황 등을 확인할 수 있는 API입니다.

POST: 문서 목록 조회

문서함의 문서 목록을 조회하고, 각 문서의 일반 정보, 상세 정보, 이력, 진행상황 등을 확인할 수 있는 API입니다.

DELETE: 문서 삭제

문서를 삭제하는 API입니다.

DELETE: 문서 취소

문서를 취소하는 API입니다.

POST: 외부 수신자 문서 재요청

외부 수신자에게 요청한 문서를 다시 요청하는 API입니다.

POST: 문서 일괄 작성

회사 멤버 계정을 통해 한 템플릿으로 문서를 여러 건 일괄 작성합니다.

POST: 문서 일괄 작성_멀티 템플릿

멤버 계정을 통 여러 템플릿으로 문서를 일괄작성하는 API입니다.

POST: 이용현황 조회

기간(연/월)별 이용현황을 조회하는 API입니다.

POST: 내부자 반려

문서 반려 시, 이전 상태로 되돌리는 API입니다.

POST: 외부자 반려

문서 반려 시, 이전 상태로 되돌리는 API입니다.

GET: 작성가능한 템플릿 목록 조회

해당 멤버가 회사에서 작성 가능한 템플릿의 목록을 조회합니다.

DELETE: 템플릿 삭제

템플릿을 삭제하는 API입니다.


멤버 및 그룹 관리를 위한 API

API를 사용해 멤버 및 그룹을 관리할 수 있습니다. 멤버 및 그룹 목록을 조회할 수 있으며, 멤버 및 그룹을 수정, 삭제할 수 있습니다.

Caution

본 API를 사용하기 위해서는 Access Token을 먼저 발급받아야 합니다. Access Token API으로 발급받은 Access Token을 다음의 위치에 있는 Authorize 버튼(image4)을 눌러 등록하세요.

Note

API의 Authorize 버튼에는 Access Token 값을 입력해야 합니다.

현재 제공 중인 멤버 및 그룹 관리 API는 다음과 같습니다.

멤버 관리 API

GET: 멤버 목록 조회

회사에 소속된 멤버 목록을 조회합니다. 삭제된 멤버를 제외한 활성, 비활성, 탈퇴 멤버의 정보를 포함한 목록을 조회할 수 있습니다.

PATCH: 멤버 수정

회사의 멤버 정보를 수정합니다.

DELETE: 멤버 삭제

회사에서 멤버를 삭제합니다. 해당 멤버의 eformsign 계정은 삭제되지 않고, 회사에서만 탈퇴됩니다.

그룹 관리 API

GET: 그룹 목록 조회

회사의 그룹 목록을 조회합니다.

POST: 그룹 추가

회사에 새로운 그룹을 추가합니다.

PATCH: 그룹 수정

회사의 그룹 정보를 수정합니다.

DELETE: 그룹 삭제

회사의 그룹을 삭제합니다.

Note

각 eformsign API에 대한 자세한 설명은 다음에서 확인하실 수 있습니다.

API 코드

Open API 사용 시 다음의 코드를 참조하시기 바랍니다.

API 상태 코드

API 상태 코드는 다음과 같습니다.

200

Code

설명

비고

200

성공

성공

202

Code

설명

비고

2020001

PDF 생성 중

  • PDF 파일 다운로드 시 파일은 비동기로 생성되기 때문에 문서 저장 후 PDF 생성까지 시간이 추가로 필요함

  • 수초에서 수분 내에 재요청 시 다운로드 가능

400

Code

설명

비고

4000001

필수 입력값 누락

API의 필수 입력값(헤더 값 또는 파라미터)이 잘목 입력되었거나 누락되었을 경우

4000002

인증 시간 만료

API 인증 요청 시간이 만료되었을 경우

4000003

API 키가 존재하지 않음

API 키가 삭제되었거나 잘못 입력했을 경우

4000004

문서가 존재하지 않음

문서 ID를 잘못 입력했을 경우

4000005

회사가 존재하지 않음

회사가 삭제되었을 경우

403

Code

설명

비고

4030001

접근 권한 없음

API가 비활성화되었을 경우

4030002

access_token 인증 오류

Access Token이 올바르지 않을 경우

4030003

refresh_token 인증 오류

Refresh Token이 올바르지 않을 경우

4030004

서명값 검증 실패

서명값이 올바르지 않을 경우

4030005

지원하지 않는 API

지원하지 않는 API 호출 시

405

Code

설명

비고

4050001

지원하지 않는 method

지원하지 않는 method 호출 시

500

Code

설명

비고

5000001~5000003

서버 에러

서버에 오류가 발생했을 경우


사용자 타입(user_type)

Type

Code

설명

내부 멤버

01

회사 내부 멤버일 경우

외부 사용자

02

회사 내부 멤버가 아닌 외부 사용자일 경우

단계 타입(step_type)

Type

Code

설명

Start

00

시작 단계

Complete

01

완료 단계

Approval

02

결재 단계(deprecated)

External

03

외부자 단계(deprecated)

Accept

04

내부자 단계(deprecated)

Participant

05

참여자

Reviewer

06

검토자

Viewer

07

열람자

문서 현재 상태 타입 (current_status.status_type)

Type

Code

설명

doc_tempsave

001

초안 (최초 작성자 임시저장 상태)

doc_create

002

문서 작성

doc_complete

003

문서 완료

doc_update

043

문서 수정

doc_request_delete

047

문서 삭제 요청

doc_delete

049

문서 삭제

doc_request_revoke

040

문서 취소 요청

doc_revoke

042

문서 취소

doc_request_reject

045

문서 반려 요청

doc_request_participant

060

참여자 요청

doc_accept_participant

062

참여자 승인

doc_reject_participant

061

참여자 반려

doc_request_reviewer

070

검토자 요청

doc_accept_reviewer

072

검토자 승인

doc_reject_reviewer

071

검토자 반려

문서 다음 상태 타입(next_status.status_type)

Type

Code

설명

초안

00

시작단계에서 임시 저장된 문서 상태

진행 중

01

문서 참여 또는 검토 요청된 상태

수정 중

02

문서를 수정 중일 때 (멤버, 최초 작성자)

완료

03

문서가 최종 완료된 상태

반려

04

참여자/검토자가 문서를 반려한 상태

취소

05

문서가 취소된 상태

취소 요청

06

문서 취소가 요청된 상태

액션 타입 (action_type)

Type

Code

설명

doc_tempsave

001

문서 임시 저장

doc_create

002

문서 생성

doc_complete

003

문서 최종 완료

doc_request_approval

010

결재 요청

doc_reject_approval

011

결재 반려

doc_accept_approval

012

결재 승인

doc_cancel

013

결재 요청 취소

doc_request_reception

020

내부자 요청

doc_reject_reception

021

내부자 반려

doc_accept_reception

022

내부자 승인

doc_accept_tempsave

023

내부자 임시 저장

doc_request_outsider

030

외부자 요청

doc_reject_outsider

031

외부자 반려

doc_accept_outsider

032

외부자 승인

doc_rerequest_outsider

033

외부자 재요청

doc_open_outsider

034

외부자 열람

doc_outsider_tempsave

035

외부자 임시 저장

doc_request_revoke

040

문서 취소 요청

doc_refuse_revoke

041

문서 취소 요청 거절

doc_revoke

042

문서 취소

doc_update

043

문서 수정

doc_cancel_update

044

문서 수정 취소

doc_request_reject

045

문서 반려 요청

doc_refuse_reject

046

문서 반려 요청 거절

doc_request_delete

047

문서 삭제 요청

doc_refuse_delete

048

문서 삭제 요청 거절

doc_delete

049

문서 삭제

doc_complete_send_pdf

050

완료 문서 PDF 전송

doc_transfer

051

문서 이관

doc_request_participant

060

참여자 요청

doc_reject_participant

061

참여자 반려

doc_accept_participant

062

참여자 승인

doc_rerequest_participant

063

참여자 재요청(외부 수신자)

doc_open_participant

064

참여자 문서 열람(외부 수신자)

doc_request_reviewer

070

검토자 요청

doc_reject_reviewer

071

검토자 반려

doc_request_reviewer

072

검토자 승인

doc_rerequest_reviewer

073

검토자 재요청(외부 수신자)

doc_open_review

074

검토자 문서 열람(외부 수신자자)