跳轉到主要內容
JSON 檔案包含的資料結構用於指定文件的數量、類型與名稱,以及每個文件的頁面數量與名稱。若要為特定使用者情境設定行動上傳,請在行動上傳連結中使用該 JSON 檔案。 md 參數可以接受兩種格式的 JSON 檔案:直接存取連結(已編碼)或已編碼的 JSON。 若要使用已編碼的連結:
  1. 產生指向 JSON 檔案的直接存取連結。
注意: 連結必須以「http://」或「https://」開頭。
  1. 將取得的連結編碼為 URL 編碼格式。
  2. 在行動上傳連結中,將已編碼的 URL 指定為 md 參數的值。
若要使用已編碼的 JSON:
  1. 將 JSON 檔案編碼為 URL 編碼格式。
  2. 在行動上傳連結中,將已編碼的 JSON 檔案指定為 md 參數的值。

JSON 結構

TransactionStructure 定義使用者在行動裝置上傳工作階段中,預期要擷取的一組文件,以便在後續的交易中進行處理。在擷取完所有文件之前,交易不會開始。
PropertiesValueDescription
version2.4目前的 ABBYY Vantage 版本。**注意:**此值應與行動裝置上傳連結中的 v 參數值相對應。
elementsElementStructure元素集合的結構。
ElementStructure 定義使用者預期要擷取的一個或多個文件集合,以便在後續的交易中進行處理。
PropertiesValueDescription
typestandalone定義僅包含一組文件的集合。
typesingle_choice定義包含多組文件的集合。**注意:**至少必須指定兩組文件。
name將在微型應用程式的 Capture Documents 畫面上顯示的文件集合名稱。**注意:**僅適用於 single_choice 類型。
documentDocumentStructure集合中單一文件的結構。**注意:**僅適用於 standalone 類型。
documentsDocumentStructure集合中所有文件的結構。**注意:**僅適用於 single_choice 類型。
DocumentStructure 定義集合中每個文件所具有的屬性集合。
PropertiesValueDescription
typeidcard定義擷取身分證正反兩面。
typepassport定義擷取護照的第一頁。
typedocument定義擷取任意文件。
name將在微型應用程式的 Capture Documents 畫面上顯示的文件名稱。
count1,2,3...在一筆交易中必須擷取的文件數量。預設值為 “1”。**注意:**在擷取完所有文件之前,上傳不會開始。
countany在一筆交易中要擷取的文件數量。**注意:**上傳會在擷取到任意數量的文件後開始。
galleryEnabledfalse/true定義是否允許從裝置的圖庫 (Gallery) 上傳文件頁面的影像。
pagesPagesStructure文件頁面的結構。
PagesStructure 定義使用者預期要擷取的文件頁面之屬性集合。
PropertiesValueDescription
nameFront side/Back side身分證各頁面的名稱。
nameFirst page with photo護照首頁的名稱。
nameDocument page name任意文件各頁面的名稱。
count1,2,3...針對該文件必須擷取的頁面數量。預設值為 “1”。在擷取完該文件的所有頁面之前,上傳不會開始。**注意:**對於身分證的正面與背面,必要的值為 “1”。
countany針對任意文件要擷取的頁面數量。上傳會在擷取到任意數量的頁面後開始。**注意:**對於護照的首頁,必要的值為 “1”;對於護照的其他頁面,必要的值為 “any”。

JSON 範例

以下為一個 JSON 結構範例,用於擷取特定數量且每份文件頁數預先定義的護照文件:
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "passport",
        "name": "護照",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "含照片的首頁",
            "count": 1
          },
          {
            "name": "其他頁面",
            "count": "any"
          }
        ]
      }
    }
  ]
}
用於擷取多個預先定義的文件中某一份的 JSON 結構範例:
{
  "version": "2.4",
  "elements": [
    {
      "type": "single_choice",
      "name": "Document",
      "documents": [
        {
          "type": "idcard",
          "name": "ID Card",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "Front side",
              "count": 1
            },
            {
              "name": "Back side",
              "count": 1
            }
          ]
        },
        {
          "type": "passport",
          "name": "Passport",
          "count": 1,
          "galleryEnabled": true,
          "pages": [
            {
              "name": "First page with photo",
              "count": 1
            },
            {
              "name": "Other pages",
              "count": "any"
            }
          ]
        }
      ]
    }
  ]
}
以下是用於擷取多份文件及(可選)身分證件的 JSON 結構範例:
{
  "version": "2.4",
  "elements": [
    {
      "type": "standalone",
      "document": {
        "type": "document",
        "name": "發票",
        "count": 1,
        "galleryEnabled": true,
        "pages": [
          {
            "name": "頁面",
            "count": "any"
          }
        ]
      }
    },
    {
      "type": "standalone",
      "document": {
        "type": "idcard",
        "name": "身分證",
        "count": "any",
        "galleryEnabled": true,
        "pages": [
          {
            "name": "正面",
            "count": 1
          },
          {
            "name": "背面",
            "count": 1
          }
        ]
      }
    }
  ]
}