新增與變更

上次更新: 2023-05-26
  • 建立對象:
  • Developer
    Admin

說明IPS API v4.0的新變更和實施變更。

使用不同的WSDL和結構描述名稱空間並排實作API版本。

  • 舊版API: IpsApi.wsdl, http://www.scene7.com/IpsApi/xsd.
  • SPS 4.0版本: IpsApi-2008-01-15.wsdl, http://www.scene7.com/IpsApi/xsd/2008-01-15.

已新增 PostScriptOptions/alpha 欄位。

已新增 VideoRootUrlSwfRootUrl 屬性 getProperty 作業。

新增選用專案 appNameappVersion 引數至 authHeader 以追蹤呼叫應用程式。 已新增記錄至 ipsApiService.log.

新增選用專案 serviceUrl 引數至WSDL產生servlet。 此引數適用於除錯代理。 例如︰http://<server>/scene7/webservice/IpsApi-2008-01-15.wsdl?serviceUrl=http://localhost:8081

已實作 getZipEntries 作業。

已實作系統欄位條件的搜尋範圍和輸入的比較值。

已新增 'Asset' 資產型別字串常數,主要用於允許跨資產中繼資料欄位。

已實作 trashState 引數: searchAssets.

已實作 getAssetPublishHistory 作業。

新增選用專案 faultHttpStatusCode SOAP標頭,可在Flex中啟用錯誤處理。 若為Flex,請使用 <faultHttpStatusCode>200</faultHttpStatusCode>. 錯誤回應的預設狀態代碼為 500 (Internal Server Error).

新增從垃圾桶還原資產和從垃圾桶還原空白資產的操作。

實作CRUD作業。

已新增啟用的標幟至 ImageMap 型別和 saveImageMap 作業。

新增對「最佳化剩餘檔案」工作的支援。

已新增 setAssetsPublishState 以取得大量發佈狀態更新。

已新增 ImageServingPublishSettingsgetImageServingPublishSettingssetImageServingPublishSettings.

已棄用 saveMetadataField 支援新增的作業 createMetadataFieldupdateMetadataField 作業。

已實作 deleteAssetsParam 批次刪除作業。

已實作 moveAssetsParam 批次移動作業。

已實作 deleteMetadataField 作業。

已實作 get/setImageRenderingPublishSettingsget/set/create/updateVignettePublishFormat 作業。

已實作 getAssetCounts.

新增支援至 setImageSetMembers 針對,包括 RenderSet 中的成員 ImageSet 資產。

已新增 replaceImage 作業。

已新增 copyImage 作業。

已新增 setUrlModifier 操作和 urlModifier/urlPostApplyModifier 欄位 LayerViewInfoTemplateInfo、和 WatermarkInfo.

已新增 createDerivedAsset 作業。 目前為 ownerHandle 必須參考影像資產,型別可以是 AdjustedViewLayerView.

已新增 createTemplate 作業。 呼叫以建立範本或浮水印資產。

IPS公司設定, CompanySettings,移轉至網站服務API。

已新增 excludeByproducts 篩選標幟至 searchAssets 作業。 將此標幟設定為true執行 PSDlayer 影像和PDF擷取的影像。

已新增 getGenerationInfo 作業。

已新增 SystemMessage 屬性名稱至 getProperty 作業。

修改部分資產型別字串常數,以符合對應的資產資訊欄位。

  • WordDoc: Word
  • ExcelDoc: Excel
  • PowerPointDoc: PowerPoint
  • RTFDoc: Rtf

修改批次作業的結果格式,以彙總成功、警告和錯誤。

已實作 batchSetAssetMetadata 批次中繼資料作業。

實作應用程式特定資料的支援。

實作布林值標幟的支援 createTemplateextendLayers、和 extractText 用於上傳工作,以控制Photoshop的處理程式(類似於新增檔案上傳的變更)。

已實作 setImageMapssetZoomTargets 作業。

已實作 ViewerPreset 作業。 可識別的型別包括:

  • VideoPlayer (影片只會發佈這些檢視器)。
  • Brochure
  • BasicZoom
  • AdvancedZoom
  • Spin
  • Custom types

檢視器外觀元素支援兩個引數: skinFgskinBg. 後端程式碼會執行維持回溯相容性所需的所有處理。

已實作 getAssociatedAssets 作業。

已新增 ReprocessAssets 允許重新處理先前上傳的主要來源檔案的工作型別,包括重新擷取PDF和重新最佳化影像。

已重新命名 PropertySetType 欄位型別至 propertyType. 此重新命名會影響 createPropertySetType 引數和 getPropertySetType/getPropertySetTypes 回應。

已實作 batchSetImageFields 支援設定影像使用者資料和其他可編輯影像欄位的作業。

47將fileSize欄位新增至各種資產資訊型別:

  • VignetteInfo
  • CabinetInfo
  • WindowCoveringInfo
  • IccProfileInfo
  • FontInfo
  • XslInfo
  • ViewerSwfInfo
  • XmlInfo
  • SvgInfo
  • ZipInfo
  • VideoInfo
  • AcoInfo
  • PdfInfo
  • PsdInfo
  • FlashInfo
  • InDesignInfo
  • PostScriptInfo
  • IllustratorInfo
  • WordInfo
  • ExcelInfo
  • PowerPointInfo
  • IllustratorInfo
  • WordInfo
  • ExcelInfo
  • PowerPointInfo
  • RTFInfo

已實作 getActivePublishContexts 作業。 此操作會傳回具有指定公司之作用中發佈伺服器的發佈內容名稱陣列。 目前的發佈內容名稱為:

  • ImageServing
  • ImageRendering
  • Video

已實作 getSearchStrings 作業。 它會傳回指定資產的搜尋字串陣列。

新增工作的地區設定引數,以及設定API作業地區設定的機制。 地區設定字串的格式應該是 <language_code>[-<country_code>]. 語言代碼是ISO-639所指定的小寫雙字母代碼,而選用的國家/地區代碼是ISO-3166所指定的大寫雙字母代碼。

將選用的地區設定引數新增至 authHeader 設定API作業地區設定的SOAP標頭。 如果此引數不存在,HTTP標頭 Accept-Language 已使用。 如果此標頭也不存在,則會使用IPS伺服器的預設地區設定。

新增強型別中繼資料欄位的get/set支援。

實作對gzip回應控制項的SOAP和HTTP標頭支援。

已新增 gzipResponse 標幟到 authHeader. 如果不存在,API會檢查HTTP Accept-Encoding 標頭。

新增對searchAssets的強型別中繼資料欄位條件支援。

  • 對於所有欄位型別,值可透過字串比較運運算元( Equals, NotEquals, Contains, NotContains, StartsWith, EndsWith)
  • 對於布林值欄位, boolVal 可透過 Equals 操作。
  • 對於Int欄位, longVal 可透過數值比較運運算元( Equals, NotEquals, LessThan, LessThanEquals, GreaterThan, GreaterThanEquals)或 minLong/maxLong 可透過數值範圍作業( Between, NotBetween)。
  • 對於Float欄位, doubleVal 可透過數值比較運運算元( Equals, NotEquals, LessThan, LessThanEquals, GreaterThan, GreaterThanEquals)或 minDouble/maxDouble 可透過數值範圍作業( Between, NotBetween)。
  • 對於日期欄位,您可以傳遞 dateVal 使用數值比較運運算元( Equals, NotEquals, LessThan, LessThanEquals, GreaterThan, GreaterThanEquals)或您可以透過數值範圍作業( Between, NotBetween)。

已新增說明, jobSubType、和 originalJobName 欄位至 JobLog 型別。

  • originalJobName 是工作名稱已提交至 submitJob (沒有任何唯一性尾碼或後續工作名稱)。
  • jobSubType 僅供 ImageServingPublishJob 工作(其中為下列之一) fullincrement, fullwithsearch,fulloverride)。
  • description 是適用於所有工作型別的空字串,但最終包含摘要工作資訊,例如上傳路徑。

此外,以下欄位不會同時包含於兩者 getJobLogsgetJobLogDetails. 在舊版中,它們僅適用於 getJobLogDetails.

  • endDate (如果工作已完成)。
  • fileDuplicateCount (之前一直 0 替換為 getJobLogs)
  • fileUpdateCount (先前一直 0 替換為 getJobLogs 並包含在 fileSuccessCount;現在會分割成個別欄位)。

將assetHandle欄位新增至 JobLogDetail 型別。

新增選用說明引數至 submitJob. 傳遞此引數以便擷取 getScheduledJobsgetActiveJobs、和 getJobLogs.

已棄用SKU系統欄位。 如果欄位作為「 」傳入,則會忽略該欄位 SystemFieldConditionsearchAssets.

已新增 excludeAssetTypeArray 篩選至 searchAssets.

已新增 MaskInfo 輸入至 Asset.

已新增IPS管理的新資產型別:

資產類型

說明

Illustrator

Adobe Illustrator檔案。

PostScript

EPS和PostScript檔案。

WordDoc

以.doc結尾之檔案的Microsoft® Word檔案。

ExcelDoc

以.xls結尾之檔案的Microsoft® Excel檔案。

PowerPointDoc

以.ppt結尾之檔案的Microsoft® PowerPoint檔案。

RTFDoc

以.rtf結尾的上傳檔案的RTF檔案。

新增其他選項至 UploadDirectoryJobUploadUrlsJob 獨立控制Postscript、Illustrator和PDF檔案的處理。 所有現有作業都會為三個處理管道的每個提供必要引數,以便它們能夠完全按照今天的方式運作。 原始 PostScriptOptions 區塊是用來設定Illustrator和EPS/PS檔案的處理作業。 您可以選擇提供特定的檔案選項區塊來指定處理。 變更清單包括:

欄位

參數

說明

PostScriptOptions

process

  • 點陣化 (預設)

  • 僅管理資產,上傳時不會建立任何衍生工具。

  • 以指定的解析度和色域將EPS和PostScript檔案演算為影像。

alpha

選擇性.

<boolean>

將檔案點陣化成影像時生效。 如果以這種方式定義原始檔案以覆蓋標誌,則會建立透明背景。

IllustratorOptions

過程

  • 點陣化 (預設)

  • 僅管理資產,上傳時不會建立任何衍生工具。

  • 以指定的解析度和色域將檔案演算為影像。

resolution

<integer>

點陣化解析度。

colorspace

呈現的目標色彩空間。

alpha

選擇性.

將檔案點陣化成影像時生效。 如果以這種方式定義原始檔案來建立重疊圖志,則建立透明背景。

PDFOptions

過程

  • 點陣化 (預設)

  • 僅管理資產,上傳時不會建立任何衍生工具。

  • 以指定的解析度和色域將檔案演算為影像。

resolution

<integer>

點陣化解析度。

colorspace

呈現的目標色彩空間。

pdfCatalog

<boolean>

定義在呈現後是否將多頁PDF合併到eCatalog中(預設為true)。

extractSearchWords

<boolean>

定義是否將PDF中的字詞擷取到DB以供稍後提供給搜尋伺服器(預設為false)。

您也可以從下列位置查詢: getScheduledJobs.

已修改 webservice.gzip.response 設定屬性以取得下列其中一個值:

說明

never

不要gzip回應。

soap

Gzip回應僅在authHeader/gzipResponse為true時。

accept

Gzip (如果authHeader/gzipResponse為true,或不存在gzipResponse標頭且HTTP Accept-Encoding標頭包含gzip)。 (預設).

always

一律gzip回應,無論標頭值為何。 此值僅用於偵錯。

本頁內容