eSignGlobaleSignGlobal
개발자 센터

ISV 생태계 애플리케이션 인터페이스 Scope 설명

1. 개요

이 문서는 생태 파트너 개발자를 대상으로 eSignGlobal 애플리케이션 인증 체계의 Scope(권한 영역)에 대한 설명을 제공합니다. 개발자가 애플리케이션 인증 연동을 수행할 경우 실제 비즈니스 기능 요구사항에 따라 해당하는 Scope를 신청해야 합니다. 각 Scope에는 해당 권한 영역 내에서 호출이 허용된 OpenAPI 목록이 포함되어 있으며, 플랫폼은 승인된 Scope에 기반하여 애플리케이션의 관련 리소스 접근 및 조작 권한을 엄격히 통제합니다.

기본 인증 인터페이스

생태 애플리케이션이 인터페이스를 정식 호출하기 전에 먼저 인증 엔드포인트를 통해 호출 자격 증명을 획득해야 합니다:

인터페이스 이름

인터페이스 경로

인터페이스 설명

AccessToken 획득

POST /esignglobal/v1/oauth2/accessToken

appid 및 appsecret를 통해 인증 access_token을 획득하여 특정 사용자 신원으로 eSignGlobal API를 요청합니다. Token 유효 기간은 24시간입니다.

현재 eSignGlobal 생태계에서 공개된 Scope 권한 영역은 주로 다음과 같습니다:

  • signature: 전자 서명 핵심 서비스
  • stamp: 도장 관리 서비스
  • comparisons: 계약서 비교 서비스

2. Scope 상세 정보 및 API 목록

2.1 Scope: signature (전자 서명 서비스)

이 Scope는 가장 기본적이고 널리 사용되는 권한 영역으로, 전자 서명 업무의 핵심 전 과정 API를 포함합니다. 해당 Scope를 승인하면 애플리케이션은 템플릿, 서명 파일(첨부 파일 포함), 참여자 및 주요 Envelope(봉투) 워크플로우를 관리하고 처리할 수 있습니다.

모듈 1: 템플릿 서비스

API 이름

API 설명

서명자 템플릿 컨트롤 세부 정보 조회

지정된 서명자의 템플릿 컨트롤 정보 및 해당 속성 구성 조회

템플릿 세부 정보 조회

특정 템플릿의 전체 정보 조회(필드 및 파일 구조 세부 정보 포함)

템플릿 데이터 입력하여 파일 생성

제공된 템플릿에 비즈니스 데이터를 채워 자동으로 PDF 형식 파일을 생성

템플릿 목록 조회

페이지네이션 또는 특정 필터 조건을 통해 현재 계정에서 사용 가능한 템플릿 목록 조회

파일 생성 작업 세부 정보 조회

비동기 작업 ID를 통해 템플릿 기반 파일 생성 작업의 최종 실행 결과 조회

모듈 2: 파일 관리

인터페이스 이름

인터페이스 설명

파일 업로드

지정된 로컬 파일 또는 업무 흐름 파일을 플랫폼에 업로드하여 이후 서명용으로 사용

키워드 기준 좌표 조회

업로드된 문서에서 텍스트 검색을 수행하고 일치하는 키워드의 위치 좌표 정보 반환

파일 다운로드

특정 완료 서명 문서, 원본 파일 또는 기타 업무 첨부 파일 다운로드

서명 파일 추가

이전에 성공적으로 업로드한 파일을 특정 서명 봉투 또는 프로세스에 바인딩

서명 파일 삭제

봉투 프로세스에서 실수로 업로드되었거나 일시적으로 서명이 필요 없는 파일 제거

첨부 파일 추가

봉투 또는 서명 프로세스에 보완적인 설명 첨부 파일 추가

첨부 파일 삭제

봉투 또는 서명 프로세스에서 지정된 첨부 문서 제거

모듈 3: 참여자 관리

인터페이스 이름

인터페이스 설명

서명자 추가

특정 봉투 프로세스에서 서명 동작을 수행해야 하는 서명 참여자 추가

서명자 삭제

특정 봉투 프로세스에서 폐기된 서명자 제거

참조 추가

참조 역할 추가, 진행 상황 알림만 수신하고 최종 서명 완료된 파일만 확인 가능

참조 삭제

특정 참조 역할 제거

모듈 4: 봉투 관리

인터페이스명

인터페이스 설명

빠른 봉투 시작

연동 플랫폼에서 이 인터페이스를 사용하여 봉투를 생성하고 서명이 완료되면 시스템이 종료 프로세스를 자동으로 처리하므로 수동으로 “봉투 종료”를 호출할 필요가 없습니다.

봉투 생성

초안 상태의 봉투를 생성하는 데 사용되며, 서명 주제, 서명자 설정 등의 매개변수 구성을 지원합니다.

봉투 시작

모든 서명 파일 및 서명자가 정확한지 확인한 후, 공식적으로 하류에 서명 작업을 발송합니다.

봉투 종료

봉투를 수동으로 종료합니다. 봉투 종료 전에는 모든 서명자가 서명을 완료해야 하며, 프로세스가 종료된 후에는 리소스를 수정할 수 없습니다.

서명 주소 조회

지정된 서명자의 전용 단축 링크 또는 직접 로드 가능한 서명 페이지 URL을 조회합니다.

봉투 상세 정보 조회

해당 봉투의 전체 정보, 연관 파일, 참여자 및 현재 진행 상태를 조회합니다.

봉투 취소

아직 전체 서명이 완료되지 않은 서명 봉투를 발신자가 능동적으로 철회합니다

서명 재촉 봉투

봉투의 서명이 완료되지 않은 경우, 현재 서명 대상이지만 미서명한 서명자에게 재촉 알림을 전송할 수 있으며, 재촉 간격은 30분입니다.

서명 미리보기 페이지 주소 조회

봉투가 생성된 후, 해당 API를 통해 서명 미리보기 페이지 주소를 조회할 수 있습니다. 주로 연동 플랫폼 내에서 봉투 참여자가 아닌 사용자가 서명 문서 및 진행 상황을 확인할 수 있도록 하는 기능에 사용됩니다.

봉투 발송 뷰 생성

봉투 ID를 사용하여 봉투 발신자 뷰를 생성합니다. 해당 뷰에서 시작된 서명 프로세스의 발신자 정보는 OAuth Access Token에서 해석된 사용자 정보로 채워집니다.


2.2 Scope: stamp (도장 관리 서비스)

이 Scope는 기업 도장 또는 개인 인장에 대한 관리 권한 부여를 전담합니다. 서명 프로세스 시작에 직접 개입할 필요 없이 기업의 통합 도장 라이브러리 유지보수(도장 등록, 삭제, 수정, 조회)만 수행하는 제3자 생태계에 적합합니다.

API 이름

API 설명

도장 목록 조회

해당 도장 조회 권한이 있는 AppID를 사용하여 도장 리소스 목록 데이터를 조회합니다.

도장 생성

권한이 있는 AppID를 사용하여 이미지 파일의 Base64 인코딩 문자열(PNG 형식 지원, 크기 18mm-100mm)을 기반으로 도장을 생성합니다.

도장 편집

이미 생성된 도장의 이름 및 이미지 등 정보 수정

도장 삭제

지정되었으나 더 이상 비즈니스 연관성이 없는 도장 리소스를 완전히 제거


2.3 Scope: comparisons (계약 비교 서비스)

이 Scope는 스마트 계약 법무 기능 도메인에 전용으로 사용됩니다. 생태계 파트너 애플리케이션이 자체 계약 심사 및 법무 평가 단계에서 텍스트 및 버전 비교 기능을 유연하게 호출하여 계약 개정 전후의 차이를 신속하게 파악할 수 있습니다.

인터페이스 이름

인터페이스 설명

계약 비교 결과 페이지 조회

비교 차이 결과를 표시하는 시각화 페이지 주소 조회

계약 비교 상세 정보 조회

계약 비교 비즈니스 ID를 통해 계약 비교 결과를 조회하며, 차이 수량(추가, 삭제, 수정 수량) 및 상세 비교 차이 내용(세부 위치 정보)을 포함합니다.