ショッピング

ファイル投稿API

  • お客様から問い合わせを受けた際に出店者様側でファイルをAPIで投稿します。
  • 2019年4月時点では注文後の質問のみファイル添付が可能です。ファイル添付ができないトピックIDを指定された場合、エラーとなって応答されます。


リクエストURL

リクエストURL(JSON)
本番環境
https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileAdd
テスト環境
https://test.circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileAdd

テスト環境用APIを利用したい場合は、こちらから利用申請をお願いします。



リクエストパラメータ

RESTリクエストの構築(PUT)」をご参照ください。

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

サンプルリクエストURL

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

サンプルリクエスト

 PUT https://circus.shopping.yahooapis.jp/ShoppingWebService/V1/externalTalkFileAdd?
 topicId=xxxxxdfs8sddfbkj46nlsdfsd8h1b3hsd4her&sellerId=teststore HTTP/1.1
 Host: circus.shopping.yahooapis.jp
 Authorization: Bearer <アクセストークン>
 
 BODY
 --AaB03x
  Content-Disposition: form-data; name="file"; filename="file1.txt"
  Content-Type: text/plain

  ... contents of file1.txt ...
 --AaB03x--


multipart/form-dataでファイルを送信ください。


レスポンスフィールド

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



サンプルレスポンス

レスポンス(JSON)

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



エラー

ファイル投稿APIはYahoo! JAPAN Web 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アクセス方法の詳細は、以下のページをご確認ください。
Yahoo! ID連携
Yahoo! ID連携によるAPIアクセス実装方法

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

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を緩和させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。

利用約款

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