跳转到主要内容
GET
若要上傳大於 10 MB 的檔案,請先取得預簽章 URL 以上傳檔案。
  • 最大檔案上傳大小 5 GB。
  • 上傳用的預簽章 URL 在產生後 30 分鐘內有效。
  • 上傳完成後的存取 URL 有效期為 30 天。所有已發布的貼文在社群網路上不受影響。已排程超過該時間範圍的貼文,在發布時將發生錯誤。
如果您的媒體已可透過外部 URL(例如 S3 儲存桶)存取,就不必再將檔案上傳到 Ayrshare。只要在 POST 到 /post 端點時,將外部可存取的 URL 放入 mediaURLs 請求主體參數,您的檔案就會被自動上傳。

標頭參數

查詢參數

fileName
string
若未提供 contentType,則必須提供包含副檔名的完整檔案名稱。要上傳的檔案名稱。必須包含副檔名,例如 .png、.jpg、.mov、.mp4 等。
contentType
string
所上傳媒體的 content-type。有效格式包含:mp4movpngjpgjpeg例如,若檔案是 Quicktime 的 .mov 檔,則 contentType 應設為 mov若未提供,將使用 application/octet-stream。

回應細節

  • accessUrl 是上傳完成後用來存取媒體檔案的 URL。
  • contentType 是所上傳媒體所設定的 content-type。上傳媒體時請在 Content-Type 標頭中使用此值。
  • uploadUrl 是用來對媒體檔案發出 PUT 請求的 URL。請參見下方說明。

其他端點範例

上傳較大檔案的流程:
  • 透過 /media/uploadUrl 端點取得 uploadURLaccessURL。請參見上方說明。
  • 透過 PUT 上傳檔案,並將 Content-Type 設定為所回傳的 contentType
  • 使用 --upload-file 搭配媒體檔案及 uploadUrl 來上傳媒體。
  • 上傳成功時,會回傳 200 回應。
  • 上傳媒體檔案後,將 accessUrl 放入 /post 端點的 mediaUrls 主體參數中執行 POST。
  • 預簽章上傳 URL 僅能上傳一次。若您傳送了錯誤的檔案,就必須重新建立新的上傳 URL。若檔案未成功上傳,將不會收到錯誤回應。 請參見下方驗證 URL 是否存在
請務必確保建立 uploadUrl 時所設定的 contentType,與 PUT 檔案時的 Content-Type 及檔案類型一致。 例如,建立 uploadUrl 時若將 contentType 設為 “image/png”,則上傳時應設定 Content-Type: image/png,且上傳的檔案應以 .png 結尾。 上傳成功時,會回傳 200 回應。

在 Node.js 中上傳二進位檔案範例

以下是使用 Node.js 搭配 JavaScript 上傳二進位媒體檔案的範例:

在 Postman 中上傳二進位檔案範例

您也可以使用 Postman 將二進位檔案上傳到 uploadUrl 在 Postman 中:
  1. 選擇 HTTP 方法 PUT
  2. 將您的 uploadUrl 貼到 url 欄位。注意,此 URL 在一小時後即過期且只能使用一次。若呼叫失敗,就必須重新產生 uploadUrl
  3. Headers 中,將 Content-Type 設為 /uploadUrl 端點回傳的 content type。例如:Content-Type: image/png
  4. 選擇 Body -> binary 並選擇要上傳的檔案。
  5. 按下 Send
  6. 重要:不會出現回傳的回應,因此您應該透過在瀏覽器中開啟 /uploadUrl 端點回傳的 accessUrl 來確認是否上傳成功。您也可以使用 verify URL 端點
Postman Binary Upload

Postman 範例 JSON 檔案