對使用者上傳的圖片嵌入 C2PA 數位簽章並返回下載地址。
介面說明
請求說明
ImageUrl和ObjectKey必須至少提供一個,如果兩個都提供,則優先使用ObjectKey。使用
ObjectKey方式時,系統會校驗該ObjectKey是否屬於當前呼叫者,不允許跨租戶存取。支援的圖片格式為 JPEG 和 PNG,不支援的格式將返回
C2PA_FORMAT_UNSUPPORTED錯誤。如果原圖已包含 C2PA 簽章,系統會保留原始簽章作為成分,並在此基礎上追加新簽章。
可透過
ClientToken參數保證請求的冪等性,但需確保其在不同請求間唯一且不超過 64 個字元。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| ClientToken |
string |
否 |
用於保證請求的冪等性。由用戶端產生該參數值,要保證在不同請求間唯一。ClientToken 只支援 ASCII 字元,且不能超過 64 個字元。 |
|
| ImageUrl |
string |
否 |
待簽章圖片的 URL 地址。支援 HTTP/HTTPS 連結。 |
|
| ObjectKey |
string |
否 |
待簽章圖片在 OSS 中的 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
|||
| SignTime |
string |
簽章時間(ISO 8601 格式),如 |
|
| RequestId |
string |
請求 ID。 |
|
| SignedImageUrl |
string |
已簽章圖片的預簽名下載地址。 |
|
| CertificateSubject |
string |
簽章憑證的主題(Subject)資訊。 |
|
| ObjectKey |
string |
已簽章圖片在 OSS 中的 ObjectKey,可用於後續介面呼叫。 |
|
| Algorithm |
string |
簽章使用的演算法,如 ps256、es256 等。 |
|
| Success |
boolean |
請求是否成功。 |
|
| Message |
string |
附加資訊。請求成功時返回 "success"。 |
|
| HttpStatusCode |
integer |
HTTP 狀態碼。請求成功時返回 200。 |
|
| Code |
string |
業務錯誤碼。請求成功時返回 "OK"。 |
樣本
正常返回樣本
JSON格式
{
"SignTime": "",
"RequestId": "",
"SignedImageUrl": "",
"CertificateSubject": "",
"ObjectKey": "",
"Algorithm": "",
"Success": true,
"Message": "",
"HttpStatusCode": 0,
"Code": ""
}
錯誤碼
|
HTTP status code |
錯誤碼 |
錯誤資訊 |
描述 |
|---|---|---|---|
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。