ファイル投稿API

  • お客様から問い合わせを受けた際に出店者様側でファイルをAPIで投稿します。
  • 「非公開」設定の質問のみファイル添付が可能です。ファイル添付ができないトピックIDを指定された場合、エラーとなって応答されます。
    • 「質問詳細API」のレスポンスパラメータ「isPrivate」フラグがたっている質問が「非公開」設定の質問になります。

変更履歴

2020年12月2日

リクエストパラメータ下の参照リンクを更新しました。
修正前：「Web APIの使い方#PUTとは」をご参照ください。
修正後：「Web APIの使い方#POSTとは」をご参照ください。

リクエストURL

本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileAdd
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileAdd

リクエストパラメータ

「Web APIの使い方#POSTとは」をご参照ください。

リクエストURL

パラメータ 必須 型 値の例 説明
topicId 〇 string xxxxxdfs8sddfbkj46nlsdfsd8h1b3hsd4her 質問のトピックID
sellerId 〇 string teststore ストアアカウント

リクエストボディ（Content-Type: multipart/form-data）

サンプルリクエストURL

https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileAdd?
topicId=xxxxxdfs8sddfbkj46nlsdfsd8h1b3hsd4her&sellerId=teststore

サンプルリクエスト

POST https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileAdd?
topicId=xxxxxdfs8sddfbkj46nlsdfsd8h1b3hsd4her&sellerId=teststore HTTP/1.1
Host: circus.shopping.yahooapis.jp
Authorization: Bearer <アクセストークン>
Content-Type: multipart/form-data; boundary="AaB03x"

--AaB03x
  Content-Disposition: form-data; name="file"; filename="file1.png"
  Content-Type: image/png

  ... contents of file1.png ...
--AaB03x--

レスポンスフィールド

要素 型 値の例 説明
objectKey string （下記参照） ファイルの保存ID

サンプルレスポンス

レスポンス（JSON）

{
    "objectKey": "dbea226919fb786f9a67cced881e4f1e57f4636f18b2b4f154feb3019f533dde/201809171212121000_SELLER.png"
  }

エラー

Yahoo!ショッピングで提供している全てのAPIには、共通で利用するエラーコードがあります。エラーの際には、まず始めに以下をご確認ください。

ファイル投稿APIで固有に返すエラーコードは以下をご覧ください。

HTTPステータスコード 説明
400 Bad request. 渡されたパラメータがWebサービスで期待されたものと一致しない場合に返されます。
ファイル投稿APIでは注文前の質問を指定した場合この応答が返されます。
401 Unauthorized. 認証に失敗した場合に返されます。
404 Not found. 存在しないリソースにアクセスされた場合に返されます。
500 Internal Server Error. サーバー側で異常が発生した場合に返されます。
503 Service unavailable. 内部的な問題によってデータを返すことができない場合に返されます。

各エラーにおいて、次の形式のJSONレスポンスを返します。

フィールド 説明
error.reason エラー事由が記載されます。 
{
     error : {
        reason: "Bad Request"
     }
}

ご注意

※こちらのAPIはYahoo! ID連携に対応したAPIです。
Yahoo! ID連携によるAPIアクセス方法の詳細は、以下のページをご確認ください。

※こちらのAPIを利用する場合は、こちらからClient ID（アプリケーションID）を取得してください。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。（1クエリー/秒）

利用約款

このAPIに関する利用約款はこちら。

アプリケーションの管理

利用のルール

開発のヒント