PacteryDevelopers

Pactery API

개발자 문서

팩터리 전자서명을 코드로 연동하는 REST API 개발자 문서. 인증, 문서 생성·발송, 서명 상태 추적, 웹훅까지.

시작하기

팩터리 API의 큰 그림과 첫 연동.

핵심 개념

팩터리 전자서명의 자원 모델과 상태 흐름.

API 레퍼런스

엔드포인트별 요청·응답 명세.

웹훅

서명 이벤트를 실시간으로 받는 방법.

부록

레퍼런스 표와 예제.

팩터리 API는 전자서명 워크플로를 여러분의 서비스에 직접 심을 수 있게 해주는 REST 인터페이스입니다. 화면을 거치지 않고 코드로 문서를 만들고, 서명자를 지정하고, 발송하고, 진행 상태를 추적합니다.

이 API로 할 수 있는 일

숍의 상품·협력사·주문(ShopProduct, ShopOption, ShopSupplier, ShopOrder)은 이 공개 API의 범위에 포함되지 않습니다. API 키로 협력사 주문이나 고객 연락처를 조회할 수 없습니다. 협력사 링크는 주문 한 건에 한정되며 만료·폐기할 수 있습니다.

수신자 인증 정책

문서 응답의 recipient_verification은 읽기 전용입니다. 국내 문서는 sms_pin, 해외 상대방 설정을 켠 문서는 email_otp가 기본이며 지원 국가의 sms_pin을 선택할 수 있습니다. 해외 설정은 문서 설정 화면에서 관리합니다. metadata.internationalSigning은 시스템 예약값으로 API에서 변경할 수 없습니다. 이메일 링크를 전달하는 것은 이메일 인증 완료가 아닙니다. OTP와 인증 증명 원문은 공개 API에 노출하지 않습니다.

블로그 게시글과 서명 이메일 인증 요청은 별도의 내부 데이터이며, 공개 API의 문서·참여자 ID와 혼용하지 않습니다.

  • 본문(HTML)이나 PDF로 문서를 생성합니다.
  • 문서 위에 서명·날인·텍스트 필드를 배치합니다.
  • **서명자(수신자)**를 지정하고 본인인증(문자 PIN) 조건을 겁니다.
  • 서명 요청을 발송하고, 각 서명자의 진행 상태를 실시간으로 추적합니다.
  • 법인 계약을 위한 **법인 도장(날인)**을 적용합니다.
  • 완료된 문서의 PDF와 감사추적 기록을 내려받습니다.
  • 웹훅으로 서명·완료 이벤트를 즉시 통지받습니다.

설계 원칙

원칙 내용
예측 가능 자원 중심 URL, 표준 HTTP 메서드와 상태 코드
JSON 기본 요청·응답 모두 application/json, UTF-8
조직 단위 API 키는 하나의 조직(Organization)에 묶여 있고, 모든 자원은 그 조직 범위 안에서 동작
안전한 재시도 생성 요청은 Idempotency-Key로 중복 방지

기본 정보

  • 베이스 URL: https://pactery.com/v1
  • 인증: Authorization: Bearer {API_KEY}
  • 시간 형식: ISO 8601 (2026-06-05T09:30:00+09:00)
  • 식별자: 자원별 접두사 (doc_, par_, fld_, seal_, evt_)

이 문서의 엔드포인트는 현재 https://pactery.com/v1 에서 동작합니다. 인증·Rate Limit(RateLimit-* 헤더)·멱등성(Idempotency-Key)·웹훅까지 구현되어 있습니다.