フォトストックに、事前にアップロードした画像を投稿します。
呼び出し先URL
{your-domain} の部分をご利用の環境にあわせて変更してください。
https://{your-domain}/h2/STRPhotoStockManipurator.doリクエスト
〇：必須△：authorもしくはstaffのどちらか必須
| パラメータ名 | 意味 | 必須 | 制約 |
|---|---|---|---|
func | 動作モード | 〇 | post を指定します。 |
key | WebAPIキー | 〇 | フォトストック操作が可能なWebAPIキーを指定します。 |
title | タイトル | 投稿タイトルを指定します。UTF-8エンコーディングで240バイト以内の文字列を指定することができます。 | |
content | メッセージ | テキストでメッセージを指定します。UTF-8エンコーディングで2000バイト以内の文字列を指定することができます。 | |
tag | タグ | タグを指定します。UTF-8エンコーディングで240バイト以内の文字列を指定することができます。 補足事項 複数のタグを指定する場合には同一パラメータ名を列挙し値を変えて指定してください。 | |
media | mediaId | 〇 | アップロード画像のIDを指定します。upload 操作の結果として返された mediaId を指定します。補足事項 複数の画像を投稿する場合には同一パラメータ名を列挙し値を変えて指定してください。 |
author | 登録者（店舗・本部ユーザー） | △ | データの投稿者となる店舗コードもしくは本部ユーザーのログインIDを指定することができます。staff パラメータとどちらかを指定する必要があります。 |
staff | 登録者（店舗スタッフ） | △ | 投稿者が店舗の場合に店舗スタッフコードを指定することができます。author パラメータとどちらかを指定する必要があります。 |
補足事項
フォームデータのPOST時には必ず application/x-www-form-urlencoded 形式で送信する必要があります。
レスポンス
APIの呼び出し結果は JSON 形式で返されます。
| 要素 | 意味 | 備考 |
|---|---|---|
postId | 投稿ID | |
timestamp | 投稿日時 | 日付/時刻は yyyy-MM-dd HH:mm:ss 形式のUTC時刻で返されます。 |
成功時のレスポンスJSON例
{
"postId": "f9f02e49-08e4-4f7c-8c14-ba96e99919d7",
"timestamp": "2020-11-25 23:35:54"
}上の例では、呼び出しは成功しており、登録された投稿IDと投稿日時が返されます。
失敗時のレスポンスJSON例
登録者の指定が不正な場合
{
"error": ["invalid parameter: 'author' is not found."]
}上の例では、呼び出しは失敗しており、登録者の指定がない旨のエラーメッセージが返されます。
mediaId の指定が不正な場合
{
"error": ["invalid parameter: 'media' contains staled mediaId. (19294a02-7f0a-431-99a0-d961a67d927a)"]
}上の例では、呼び出しは失敗しており、mediaId の指定が正しくない旨のエラーメッセージが返されます。