將圖片轉成 PDF 並建立任務

POST - /api/v1/task/createByPic

參數

{
  "apiKey": "string",
  "initiatorName": "string",
  "emailSubject": "string",
  "name": "string",
  "expiredDate": "2023-01-05T07:13:28.581Z",
  "isOverlay": true,
  "isParallel": false,
  "returnUrl": "string",
  "sendDoneMailToSigner": true,
  "cc": [
    {
      "email": "string",
      "name": "string"
    }
  ],
  "datas": [
    {
      "contents": [
        {
          "data": [
            {
              "id": 0,
              "x": 0,
              "y": 0,
              "type": 0,
              "width": 0,
              "height": 0,
              "required": true,
              "readonly": false,
              "label": "string",
              "groupId": 0,
              "groupLabel": "string",
              "selected": true,
              "fontSize": 0,
              "fontFamily": "string",
              "fontStyle": "string",
              "fontWeight": "string",
              "textAlign": "string",
              "textColor": "string",
              "maxlength": 0,
              "text": "string",
              "dateFormat": "string",
              "dateRange": "string",
              "options": [
                {
                  "id": 0,
                  "name": "string"
                }
              ],
              "selectOptionId": 0,
              "ruleId": 0,
              "maximum": 0,
              "minimum": 0,
              "validation": {
                "errorMessage": "string",
                "regex": "string",
                "type": "string"
              }
            }
          ],
          "page": 0
        }
      ],
      "fileName": "string",
      "imageList": ["string"]
    }
  ],
  "option": {
    "datas": [
      {
        "groupLabel": "string",
        "label": "string",
        "value": "string"
      }
    ]
  },
  "person": [
    {
      "email": "string",
      "name": "string",
      "phone": "string",
      "needVideo": false,
      "isFace": false,
      "isNeedOtp": false,
      "hostEmail": "string",
      "hostName": "string"
    }
  ],
  "reviewer": [
    {
      "email": "string",
      "name": "string",
      "personIndex": 0
    }
  ]
}
  • apiKey - API 金鑰
  • name - 任務名稱
  • initiatorName - 發起人名稱
  • emailSubject - 簽署信件主旨
  • cc (陣列) - 副本收件人，在完成任務後收到簽核結果
    • email - 副本收件人 email
    • name - 副本收件人名稱
  • expiredDate - 文件簽署期限，有設定請給 UTC+0 時區時間(Ex: 2022-12-02T07:00:17.300Z)，沒有請給 null
  • isOverlay - 下一個人是否要看到上一個人的簽署內容
  • isParallel - true 爲不設定簽核順序，當簽核成員有「只審核」的成員（AUDITOR）時要是 false（要有簽核順序）
  • returnUrl - 簽署完成跳回頁面 (SI 用戶)
  • sendDoneMailToSigner - 是否寄送完成信件給簽署者 (預設為true)
  • person (陣列) - 簽核成員
    • email - 簽核成員的 email，現場簽(isFace=true)不用提供
    • phone - 簽核成員的電話，如果填寫將用簡訊寄送簽署連結 (請確保公司點數符合簡訊點數要求)
    • name - 簽核成員的名字
    • needVideo - 完成簽署時是否需要進行聲明錄影
    • otpType - 要求文件密碼方式 (已棄用，請改使用isNeedOtp)
      • NONE - 不要求
      • EMAIL_READ - 讀取文件時以電子郵件寄送
    • isFace - 是否為現場簽
    • isNeedOtp - 是否需要 OTP
    • hostEmail - 現場簽指定主持人 email (預設為發起人)
    • hostName - 現場簽指定主持人名字 (預設為發起人)
    • culture - 信件語系 目前支援 zh-TW、en
  • reviewer (陣列) - 額外的審核人員
    • email - 審核人員的 email
    • name - 審核人員的名字
    • personIndex - 安插在哪一個簽核成員前面
  • option - 額外資料
    • datas (陣列) - 需要預先填入的值，對應欄位的標籤
      • groupLabel - 群組標籤
      • label - 對應欄位的標籤
      • value - 對應欄位預先填入的值
  • datas (陣列) - 創建任務的檔案，每一個檔案包含圖片列表以及簽署位置資訊
    • fileName - 檔案名稱
    • contents (陣列) - 簽署位置資訊
      • page - 頁數
      • data (陣列) - 簽署物件
        • id - 成員 id，對應 person 的 index
        • x - x 座標，每頁最左上角為 0，最大值為該頁的寬度
        • y - y 座標，每頁最左上角為 0，最大值為該頁的高度
        • type (列舉) - 簽署物件類別
          • 0 - 簽名
          • 1 - 文字
          • 2 - 核取方塊 (checkbox)
          • 3 - 印章
          • 4 - 日期
          • 5 - 選擇按鈕 (radio)
          • 6 - 下拉式選單
          • 7 - 附件
          • 8 - 圖片
          • 9 - 簽名 - 自然人憑證
          • 10 - 簽名 - 工商憑證
          • 11 - 印章 - 自然人憑證
          • 12 - 印章 - 工商憑證
          • 13 - 簽名或印章
          • 14 - 畫布
        • width - 物件寬度(px)
        • height - 物件高度(px)
        • required - 是否必填
        • readonly - 物件唯讀，目前只支援文字
        • label - 物件標籤
        • groupId - 群組 id，將需要合併成同一群組的checkbox和radio設定成同一 id
        • groupLabel - 群組標籤，checkbox和radio在設定groupId後可設定群組標籤
        • selected - 是否勾選 - checkbox和radio是否勾選
        • fontSize - 文字欄位字型大小
        • fontFamily - 文字欄位字型
          • Arial
          • Arial Narrow
          • Calibri
          • Courier New
          • Georgia
          • Helvetica
          • Times New Roman
          • PMingLiU - 新細明體
          • DFKai-sb - 標楷體
          • Microsoft JhengHei - 微軟正黑體
        • fontStyle - 文字斜體
          • italic - 斜體
          • normal - 不使用斜體
        • fontWeight - 文字粗體
          • bold - 粗體
          • normal - 不使用粗體
        • textAlign - 文字置左/中/右
          • left - 置左
          • center - 置中
          • right - 置右
        • textColor - 文字顏色 (請使用 rgba 方式代表顏色，舉例來說 rgba(255,255,255,1)會顯示白色)
        • maxlength - 文字欄位字數限制
        • text - 文字欄位值
        • dateFormat - 日期欄位格式
          • YYYY/MM/DD - Y:年、M:月、D:日
          • DD/MM/YYYY - Y:年、M:月、D:日
          • MM/DD/YYYY - Y:年、M:月、D:日
        • dateRange - 日期欄位範圍
          • none - 無限制
          • signDay - 簽署當天
          • beforeSignDay - 簽署日以前
          • afterSignDay - 簽署日以後
        • options (陣列) - 下拉式選單欄位 選項
          • id - 選項 id
          • name - 選項值
        • selectOptionId - 下拉式選單欄位值
        • ruleId - checkbox規則
          • 0 - 選取至少 - 需要設定minimum，checkbox 群組需要選取至少 minimum 的選項
          • 1 - 選取至多 - 需要設定maximum，checkbox 群組需要選取至多 maximum 的選項
          • 2 - 選取剛好 - 需要設定maximum，checkbox 群組需要選取剛好 minimum 的選項
          • 3 - 選取範圍 - 需要設定minimum和maximum，checkbox 群組需要選取在 minimum 和 maximum 範圍的選項
        • maximum - checkbox 選取規則最大值
        • minimum - checkbox 選取規則最小值
        • validation - 文字欄位驗證
          • type - 文字欄位驗證類型
            • idcard - 身分證
            • email - 電子郵件
            • phone - 電話
            • zip - 郵遞區號
            • number - 數字
            • custom - 自訂
          • regex - 當 type 設定為custom，可設定自訂的 Regular Expression (Ex. \d{1,})
          • errorMessage - 當 type 設定為custom，可設定自訂的錯誤訊息
    • imageList (陣列) - 圖片列表
      • base64Content - 圖片檔案 Base64 String
      • contentType - 圖片檔案的 Mime Type (Ex: img/png)
      • fileName - 圖片檔案的檔案名稱

回傳

{
  "body": {
    "instanceId": "string",
    "signUrl": "string"
  },
  "errorCode": 0,
  "message": "string"
}
  • instanceId - 任務 Instance Id
  • signUrl - 簽署連結，當發起人為現場簽主持人時，會回傳簽署連結

預填資料

請參考 建立任務 - 預填資料

額外審核人員

請參考 建立任務 - 額外審核人員

errorCode 錯誤代碼

請參考 錯誤碼和錯誤訊息 頁面

Table of Contents