売場ノートの投稿用のAPIを追加しました
APIを用いて売場ノートの投稿が行えます。
売場ノートの投稿を行うためにはWebAPIキーに「売場ノートの投稿API」の権限が必要になります。
[ システムの管理 ] > [ 連携アプリの設定 ] > [ WebAPIキーの管理 ] よりWebAPIキーに権限を追加してください。
- 売場ノートの投稿APIのエンドポイント
POST https://your-domain/h2/api/v1/shopnote/{投稿テーマID}/compose
ドメイン名の部分はご利用の本サービスドメイン名を指定してください。
{投稿テーマID}は [ 売場ノートの管理 ] > [ 売場ノートのテーマの編集 ] > [ ID ]欄に記載されているテーマIDを指定してください。
- リクエストヘッダー
| ヘッダー | 必須 | 値 |
| Host: | ○ | your-domain |
| X-ShopRun-Auth: | ○ | {WebAPIキー} |
| Content-Type: | ○ |
application/json
|
| Content-Length: | ○ |
|
- リクエストボディ(JSON形式)
| キー | 必須 | 初期値 | 値 |
| operator | ○(本部ユーザ、スタッフの場合) | - |
投稿者となる本部ユーザーのログインIDもしくは店舗スタッフのスタッフコード
|
| store |
○(店舗、スタッフの場合) |
- |
店舗からの投稿の場合に店舗コード
|
| title | - | 指定しない場合はタイトル無しで投稿 |
タイトル文字列
|
| content | - | 指定しない場合は本文無しで投稿 |
本文
|
| keywords | - | 指定しない場合はキーワード無しで投稿 |
キーワードの配列
|
| images | - | 指定しない場合は画像無しで投稿 |
添付する画像を Data URI 形式にエンコードしたものの配列
|
| restriction | - | 0=公開 |
0=公開, 1=店舗とエリアマネージャー, 2=エリア内
|
| latitude, longitude, altitude | - | - |
緯度、経度、高度
|
- レスポンス
| ステータスコード | 例 | |
| 200 | OK | APIが正しく処理された場合 |
| 400 | Bad Request |
Content-Length:が誤っている場合 リクエストボディがJSON形式ではない場合 |
| 401 | Unauthorized | X-ShopRun-Auth:が誤っている場合 |
| 404 | Not Found | {投稿テーマID}が無いなど、エンドポイントが誤っている場合 |
APIが正しく処理された場合は次のようなレスポンスが返答されます。
StatusCode : 200OK
{
"attachments": [
投稿画像情報
],
"keywords": ["キーワード"],
"author": {
投稿本部ユーザ/店舗情報
},
"placeId": "投稿テーマID",
"regDate": "投稿時間(UTC)",
"noteId": "投稿ID",
"staff": {
投稿店舗スタッフ情報
},
"title": "タイトル",
"content": "本文",
"updDate": "更新時間(UTC)",
"authorName": "店舗名",
"restriction": {公開範囲},
"staffName": "店舗スタッフ名",
"latitude": "緯度",
"longitude": "経度",
"altitude": "高度"
}
リクエストボディの値が誤っているなど、APIは正しく処理されたが投稿はできなかった場合は次のようなレスポンスが返答されます。
StatusCode : 200OK
{
"errors": [
"'operator' should be specified."
]
}