概述:圖片接口

圖像 API 允許您檢索圖像的調整大小、裁剪或旋轉版本。

簡介

Brightcove 圖像 API 提供了一種使用簡單的 GET 請求調整圖像大小、裁剪和/或旋轉圖像的快速簡便的方法。

請求網址

圖像 API 的請求 URL 是:

https://images.brightcovecdn.com/image/v1/{account_id}/{image-token}/url/{image_url}

所需的路徑參數是:

  • account_id:您的視頻雲帳戶 ID
  • image-token:您帳戶的身份驗證令牌(必須由 Brightcove 支持生成)
  • image_url : 可以在其中找到圖像的公共 URL

網址參數

要獲得圖像的轉換版本,請在您的請求中使用下面描述的一個或多個 URL 參數。請注意,您可以使用 3 個參數的任意組合。

Image API 的 URL 參數
參數 描述
resize 通過將其設置為“widthxheight”來調整圖像大小 - 例如:resize=160x90 )
fallback 如果true , 如果無法返回請求的圖像,API 將返回黑色圖像。
fillArea 保持圖像的縱橫比完全填充調整大小參數給定的區域。默認行為僅填充同一區域的一側。
crop 通過將其設置為“widthxheight”來裁剪寬度和高度 - 例如:crop=160x90 - 原點是圖像的中心。
rotate 按指定的度數順時針旋轉圖像 - 例如:rotate=90
nocache 如果true API 響應將包括Cache-Control帶有值的標頭public, max-age=0 .
watermark 如果true播放按鈕圖標將添加到圖像

最佳實務

如果您轉換後的圖像將顯示在網頁或在線應用程序中,請使用 API 檢索圖像並將它們存儲在您的服務器上。不要 在運行時檢索它們,因為 API 的速率限制會導致某些請求在高流量頁面或應用程序上失敗,並且它還會通過強制每次都發出 API 請求來降低頁面/應用程序的性能由用戶加載。

範例

以下是示例的原始圖像:

原圖
原始圖像 (726x985)

調整大小(使用resize範圍)

請求

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?resize=221x300
調整大小的圖像
調整大小的圖像

裁剪

請求

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?crop=580x670
裁剪圖像
裁剪圖像

旋轉的

請求

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?rotate=-90
旋轉圖像
旋轉圖像

調整大小和填充區域

請求

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?resize=200x300&fillArea=true
調整大小和填充區域
調整大小和填充區域

調整大小和旋轉

請求

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?resize=221x300&rotate=-90
調整大小和旋轉圖像
調整大小和旋轉圖像

裁剪和旋轉

請求

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?crop=570x660&rotate=-90
裁剪和旋轉圖像
裁剪和旋轉圖像

調整大小、裁剪和旋轉

請求

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?resize=221x300&crop=570x660&rotate=-90
調整大小、裁剪、旋轉圖像
調整大小、裁剪、旋轉圖像

水印

請求

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?watermark=true
水印
水印

無緩存

請求

https://images.brightcovecdn.com/image/v1/1752604059001/XXXXXXXXXX/url/https%3A%2F%2Fapis.support.brightcove.com%2Fassets%2Fimages%2Fimage-api%2Fleaf.jpg?resize=221x300&nocache=true

以下是響應標頭(由 Insomnia返回)。

響應頭
響應頭