SSignKing싸인킹
문서함 열기

메뉴

서비스요금 안내이용 가이드개발자 문서

SignKing for developers

계약 업무를
당신의 시스템에 연결하세요.

기본 REST API와 원격 MCP.
작업공간의 템플릿·서명 요청·완료 문서를 함께 관리합니다.

현재 고객별 독립 가입·REST API 발급은 개통 준비 중입니다. 문서는 공개되어 있으며 기존 승인된 관리자·MCP 연결은 해당 권한 범위에서 사용합니다.

01. 연동 시작하기

  1. 작업공간의 이메일 인증과 라이선스 연결을 완료합니다.
  2. 계정·사용량 → API·MCP에서 필요한 권한만 선택해 키를 발급합니다.
  3. 템플릿 상세에서 실제 역할·입력 키·서명 필드를 확인합니다.
  4. 조회부터 검증하고 사용자 승인 후 서명 요청을 생성합니다.
기본 주소
https://sign.everb.co.kr/api/v1

브라우저 작업 화면의 내부 프록시인 /api/signking은 외부 고객 연동용 API와 구분됩니다.

02. 인증과 권한

조회 요청
curl 'https://sign.everb.co.kr/api/v1/templates' -H 'Authorization: Bearer YOUR_API_KEY'

API 키는 한 번만 표시되며 서버에 안전하게 보관합니다. 키를 브라우저 코드·공유 저장소에 넣지 마세요. 발급된 작업공간 밖의 문서에는 접근할 수 없습니다. 키를 폐기하면 그 키에 연결된 OAuth 권한도 사용할 수 없습니다.

권한허용 작업
templates:read템플릿 목록·상세 조회
templates:write템플릿 등록
requests:read요청·진행·완료본·사용량·라이선스 조회
requests:write서명 요청 생성

외부 API는 Bearer 인증을 사용합니다. 브라우저 로그인 쿠키만 복사해 외부 시스템에 사용하지 마세요.

03. API 레퍼런스

성공 응답은 해당 작업의 JSON입니다. 요청 생성은 201, 조회는 200으로 응답합니다. ID는 목록·생성 응답에서 받은 실제 값을 사용합니다.

GET/api/v1/templates

템플릿 목록

작업공간에 저장된 템플릿을 조회합니다.

필요 권한 templates:read
GET/api/v1/templates/{id}

템플릿 상세

실제 HTML, 역할과 입력 필드를 확인합니다.

필요 권한 templates:read
POST/api/v1/templates

템플릿 등록

HTML 문서와 서명자 역할, 필드를 등록합니다.

필요 권한 templates:write
GET/api/v1/requests

서명 요청 목록

status=all|pending|signed, limit=1~1000으로 최근 요청을 조회합니다.

필요 권한 requests:read
POST/api/v1/requests

서명 요청 생성

템플릿을 기반으로 서명 요청을 생성합니다. Idempotency-Key가 필요합니다.

필요 권한 requests:write
GET/api/v1/requests/{id}

서명 진행 상세

서명자별 진행 상태와 요청 정보를 조회합니다.

필요 권한 requests:read
GET/api/v1/requests/{id}/document

완료 문서 조회

완료 문서의 읽기 전용 열람 링크를 반환합니다.

필요 권한 requests:read
GET/api/v1/usage

사용량 조회

기간별 성공 건수와 결과 확인 중인 예약 건수를 조회합니다.

필요 권한 requests:read
GET/api/v1/license

라이선스 조회

작업공간의 라이선스·구독 준비 상태를 확인합니다.

필요 권한 requests:read

요청 목록은 최근 요청을 대상으로 하며 possibly_truncated=true이면 전체 결과가 아닐 수 있습니다. 완료 문서는 전체 서명이 끝난 뒤 조회하며 7일 유효한 열람 링크를 반환합니다. 링크 소지자가 문서를 열 수 있으므로 공개 게시하지 마세요.

04. 서명 요청 생성

cURL · 서명 요청
curl -X POST 'https://sign.everb.co.kr/api/v1/requests' -H 'Authorization: Bearer YOUR_API_KEY' -H 'Content-Type: application/json' -H 'Idempotency-Key: a76d6cee-ec79-4bbc-9554-7a41672e95d4' -d '{"template_id":"YOUR_TEMPLATE_ID","signing_mode":"sequential","signers":[{"role":"signer","name":"서명자 이름","email":"signer@example.com","order":1}],"values":{"document_title":"용역 계약서"}}'

role과 values 키는 템플릿에 저장된 값과 맞아야 합니다. 여러 서명자는 signers 배열로 전달합니다. 동적 표는 tables에 표 키·열 키로 행을 전달하며, 필수 표는 누락할 수 없습니다.

응답 구조 예시 · 실제 ID와 링크는 생성 시 반환
{
  "request": {
    "record_id": "REQUEST_ID",
    "status": "requested"
  },
  "invitations": [
    {
      "role": "signer",
      "signer_name": "서명자 이름",
      "token": "SIGNING_TOKEN"
    }
  ]
}

요청 생성과 이메일 발송은 별도입니다. 이 API 예제는 이메일을 자동 발송하지 않습니다. 반환된 초대 링크를 승인된 전달 방식으로 공유하거나 웹 발송 관리에서 발송하세요. 서명 요청 생성 성공 시 문서당 1건을 사용합니다.

재시도는 같은 키로.

각 새 계약에 새 UUID를 Idempotency-Key로 사용합니다. 응답이 끊기면 같은 키·같은 본문으로 재확인하며, 새 키로 재생성하지 않습니다. 같은 키에 다른 본문을 보내면 409가 반환됩니다.

05. MCP와 OAuth 연결

원격 MCP 주소
https://sign.everb.co.kr/api/mcp

OAuth를 지원하는 원격 HTTP MCP 클라이언트에서 연결합니다. 동적 클라이언트 등록·PKCE·권한 승인을 지원하며 승인 화면에는 작업공간 API 키를 입력합니다. 지원 클라이언트에서는 Client ID·Secret을 직접 입력할 필요가 없습니다.

Bearer 연결 설정 예시 · 클라이언트 규격 확인
{
  "mcpServers": {
    "signking": {
      "url": "https://sign.everb.co.kr/api/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_API_KEY"
      }
    }
  }
}

사용 도구: template_list, template_get, template_analyze, document_tables_parse, template_create, signing_request_create, signing_request_list, signing_request_get, signing_document_get입니다.

고객 작업공간의 signing_request_create에는 idempotency_key UUID가 필요합니다. AI가 요청을 작성하더라도 실제 계약 생성 전 문서와 수신자를 확인하세요.

06. 오류·호출 제한·정산

상태확인할 사항다음 행동
401인증 키 누락·만료·폐기발급 키와 Bearer 헤더 확인
403이메일 인증·권한·요청 출처작업공간과 키 권한 확인
402구독 기간·추가 사용 한도계정·사용량에서 확인
409중복·진행 중·결과 불명·문서 충돌기존 키로 결과 확인, 새 계약 반복 금지
422입력 데이터 형식템플릿 역할과 필드 확인
429호출 빈도 제한간격을 늘리고 재시도
503작업공간 준비·외부 연결상태 확인 후 같은 요청으로 재확인

현재 인증된 계정·키 기준 분당 300회 호출 제한을 적용합니다. 결과 미확정 요청은 한도를 예약하고 정산을 보류합니다. 실패가 확인된 요청은 사용량을 차감하지 않습니다. 진단 번호가 있다면 문의 시 함께 전달하되 API 키·문서 원문은 보내지 마세요.

오류 응답 형태
{
  "message": "작업공간 또는 요청 상태를 확인해 주세요."
}