Home
개정내용
Start typing to search…
Back to All

위드싸인 API 변경사항 (v2.2)

about 2 months ago by widsign

안녕하세요. 위드싸인 서비스팀입니다.

위드싸인 API V2.2 버전 업데이트에 대한 변경사항을 안내해 드립니다.

변경사항 요약

위드싸인 API V2.2 버전에 반영된 주요 변경사항 요약입니다. 변경된 API 스펙에 대한 상세 내용은 아래 본문을 참고해 주십시오.

업무변경유형관련 항목변경 내용
계약서 목록 조회상태값 변경statusnull 일때 ‘SEND’로 기본값 적용
조회 조건 추가send_id조회 조건에 계약발송아이디(send_id) 추가
계약서 상세 조회상태값 변경doc_statusnull 일때 ‘SEND’로 기본값 적용
계약서 발송Response 항목 추가send_idResponse 에 계약발송아이디(send_id) 추가
로직 개선receiver_list,send_type수신자1명이고 순차발송시 동시전송으로 처리 개선

계약서 목록 조회

API Endpoint : (GET) https://api.widsign.com/v2/doc

변경내용

  • 계약서 목록 조회 결과, 계약진행상태(status)가 null 값일 경우 'SEND'로 기본 적용됩니다.
  • 계약서 목록 조회를 요청할 때 계약발송아이디(send_id)로 조회할 수 있는 조건이 추가되었습니다.

변경내용 상세

계약진행상태(status) 값 변경

변경 전(V2.1)변경 후(V2.2)
null (빈값)SEND (전송)
WRITING (작성중)WRITING (작성중)
CANCEL (발신자 취소)CANCEL (발신자 취소)
REJECT (수신자 거절)REJECT (수신자 거절)
EXPIRATION (계약서 만료)EXPIRATION (계약서 만료)
END (완료)END (완료)
  • 조회 결과 예시
{
    "svc_owner_id": 100344,
    "total_count": 2,
    "page": 1,
    "page_size": 10,
    "page_count": 1,
    "result": [
        {
            "form_id": "6933db059bf01e998f9c9ab8",
            "send_id": 6397,
            "title": "표준근로계약서1-API 테스트2",
            "send_type": "SAMETIME",
            "group_count": 1,
            "one_click_url": null,
            "expiration_date": "",
            "password": null,
            "auth_phone": "N",
            "sender_email": "[email protected]",
            "status": "SEND",
            "created_date": "2025-12-11 09:54:29",
            "group_id": 0,
            "receiver_list": [
                "693a1646342b7705510fa7c2"
            ]
        },
        {
            "form_id": "6933db059bf01e998f9c9ab8",
            "send_id": 6396,
            "title": "표준근로계약서1-API 테스트",
            "send_type": "SAMETIME",
            "group_count": 1,
            "one_click_url": null,
            "expiration_date": "",
            "password": null,
            "auth_phone": "N",
            "sender_email": "[email protected]",
            "status": "END",
            "created_date": "2025-12-06 19:10:19",
            "group_id": 0,
            "receiver_list": [
                "6934010b3887537a568305cd"
            ]
        }
    ]
}

계약서 조회 조건 (Query Params) 변경

변경 전변경 후
page (페이지 번호)page (페이지 번호)
page_size (페이지 크기)page_size (페이지 크기)
status (계약서 진행상태)status (계약서 진행상태)
receiver_name (수신자이름)receiver_name (수신자이름)
receiver_email (수신자 이메일)receiver_email (수신자 이메일)
receiver_phone (수신자 전화번호)receiver_phone (수신자 전화번호)
sender_email (발신자 이메일)sender_email (발신자 이메일)
group_id (그룹번호)group_id (그룹번호)
send_id (계약서 발송 아이디)
sort (정렬키)sort (정렬키)
  • Query Param 예시
https://api.widsign.com/v2/doc?send_id=6397

계약서 상세 조회

API Endpoint : (GET) https://api.widsign.com/v2/detail

변경내용

  • 계약서 상세 조회 결과, 계약진행상태(doc_status)가 null 값일 경우 'SEND'로 기본 적용됩니다.

변경내용 상세

계약진행상태(doc_status) 값 변경.

변경 전(V2.1)변경 후(V2.2)
null (빈값)SEND (전송)
WRITING (작성중)WRITING (작성중)
CONVERT (계약서 PDF 생성중)CONVERT (계약서 PDF 생성중)
END (완료)END (완료)
CANCEL (발신자 취소)CANCEL (발신자 취소)
REJECT (수신자 거절)REJECT (수신자 거절)
EXPIRATION (계약서 만료)EXPIRATION (계약서 만료)
STANDBY (원클릭 계약 승인)STANDBY (원클릭 계약 승인)
APPROVAL-END (원클릭 계약 승인)APPROVAL-END (원클릭 계약 승인)
APPROVAL-REJECT (원클릭 계약 거절)APPROVAL-REJECT (원클릭 계약 거절)
  • 조회 결과 예시
{
    "svc_owner_id": 100344,
    "result": {
        "receiver_list": [
            {
                "id": "693a1646342b7705510fa7c2",
                "name": "수신자1",
                "email": "[email protected]",
                "mobile": null,
                "password": null,
                "send_url": "https://s.widsign.com/230f729ba9",
                "send_url_mobile": "https://s.widsign.com/eb0ae99ee8",
                "email_sent_date": "2025-12-11 09:54:30",
                "sms_sent_date": null,
                "doc_status": "SEND",
                "group_number": 1
            }
        ],
        "doc": [
            {
                "page_id": "6933db0a9bf01e998f9c9ab9",
                "background": {
                    "w": 1240,
                    "h": 1754,
                    "url": "https://s3.ap-northeast-2.amazonaws.com/6933db059bf01e998f9c9ab8/../1765006085794_0.png"
                },
                "items": [
                    {
                        "name": "수신자서명1",
                        "type": "SIGN",
                        "id": "6933db64861ada40bf000001",
                        "required": "Y",
                        "group_num": "1",
                        "values": null
                    }
                ]
            }
        ]
    }
}

계약서 발송

API Endpoint : (POST) https://api.widsign.com/v2/form/send

변경내용

  • 계약서 발송 후 응답값(response)에 계약발송아이디(send_id) 항목을 추가 제공합니다.
  • 수신자가 1명이고 순차전송을 선택한 경우의 처리 개선되었습니다.
    • 수신자1명일 때는 시스템에서 순차전송을 동시전송으로 처리

변경내용 상세

계약서 발송 후 응답값(response) 항목 추가.

변경 전(V2.1)변경 후(V2.2)
svc_owner_id (서비스 계정번호)svc_owner_id (서비스 계정번호)
send_id (계약발송아이디)
result (배열) 생략result (배열) 생략
  • 계약서 발송 후 응답값 예시
{
    "svc_owner_id": 100344,
    "send_id": 6397,
    "result": [
        {
            "svc_owner_id": 100344,
            "sender_email": "[email protected]",
            "sender_name": "TEST(Dev)",
            "sender_mobile": null,
            "form_id": "6933db059bf01e998f9c9ab8",
            "doc_name": "표준근로계약서1-API 테스트2",
            "receiver_meta_id": "693a1646342b7705510fa7c2",
            "receiver_name": "수신자1",
            "receiver_email": "[email protected]",
            "receiver_mobile": null,
            "password": null,
            "send_url": "https://s.widsign.com/230f729ba9",
            "send_url_mobile": "https://s.widsign.com/eb0ae99ee8"
        }
    ]
}

수신자 1명이고 순차전송을 선택한 경우의 처리 개선.

  • 수신자1명 순차전송(SEQUENTIAL) 선택 발송 예시

    • Request Body
    {
  "form_id": "6933db059bf01e998f9c9ab8",
  "receiver_list": [
      {
          "name": "수신자1",
          "email": "[email protected]"
      }
  ],
  "send_member": "[email protected]",
  "send_group": 0,
  "title": "표준근로계약서1-API 테스트3",
  "send_type": "SEQUENTIAL"
}
    • Response
    {
  "svc_owner_id": 100344,
  "send_id": 6398,
  "result": [
      {
          "svc_owner_id": 100344,
          "sender_email": "[email protected]",
          "sender_name": "TEST(Dev)",
          "sender_mobile": null,
          "form_id": "6933db059bf01e998f9c9ab8",
          "doc_name": "표준근로계약서1-API 테스트3",
          "receiver_meta_id": "693a18bd342b7705510fa7c8",
          "receiver_name": "수신자1",
          "receiver_email": "[email protected]",
          "receiver_mobile": null,
          "password": null,
          "send_url": "https://s.widsign.com/ed6264185b",
          "send_url_mobile": "https://s.widsign.com/74cd192a80"
      }
  ]
 }