PlatinaMalls API (1.0.0)

Download OpenAPI specification:Download

概要E/h2>

プラチナモール以外�ECMS�E�以下、外部CMS�E�で管琁E��てぁE��スポットと、�Eラチナで管琁E��てぁE��スポットを連携するためのAPIです、Ebr>プラチナモールをご利用のお客様において施設Webサイト�ECMSめE��の他�E管琁E��スチE��をお持ちの場合、このAPIをご活用ぁE��だくことでプラチナモールの施設スポット情報と連携し、外部Webサイトとプラチナモールの間でシームレスな惁E��更新が可能となります、E/p>

Overview

チE�Eタ連携の流れ

スポットを登録する
スポット�E多言語情報を登録する
スポット�E混雑状況を登録する
スポット�E惁E��を更新する
スポットを非�E開にする
スポットを削除する

1. スポットを登録する

外部CMSでスポットを登録した際などに、スポット登録APIを呼び出してください、E

対象マップを持E��する�EチE�EスラグはマップURLからご確認いただけます、Ebr>�E��EチE�EURLぁEhttps://platinumaps.jp/d/XXXXXXXX の場合！Ecode>XXXXXXXXが�EチE�Eスラグを指します。！E/p>

登録の際に忁E��頁E��となるフロアID FloorId、カスタム頁E��ID CustomPropertyId、カチE��リID CategoryId、ピクトグラムID PictgramIdはプラチナモールの管琁E��面にてご確認ください、E/p>

2. スポット�E多言語情報を登録する

※ 言語によらず�E通である頁E��E�侁E 緯度、経度など�E�も同時に更新対象となるため、更新したくなぁE��E��頁E��に対しては、スポット詳細取得APIで取得した値を設定してください、E/p>

3. スポット�E混雑状況を登録する

登録したスポット�E混雑状況を登録また�E更新する場合�E、スポット混雑状況更新APIを呼び出してください、E/p>

4. スポット�E惁E��を更新する

外部CMSでスポットを更新した際などに、スポット更新APIを呼び出してください、E/p>

5. スポットを非�E開にする

外部CMSでスポットを一時的に削除した際など�E�削除からの取り戻しが可能である場合）に、スポット更新APIを利用して、スポット�EチE�Eタを維持したまま、E��公開状態にすることができます、Ebr>再�E公開する場合もスポット更新APIを利用してください、E/p>

6. スポットを削除する

外部CMSでスポットを完�Eに削除した際などに、スポット削除APIを呼び出してください、E/p>

認証方弁E/h2>

弊社より発行されたAPIキーをHTTPヘッダの x-api-key に設定してください、E/p>

spots

スポット情報を扱ぁEPIカチE��リです、E/p>

スポット一覧

持E��した�EチE�EIDにおけるスポット�E一覧を返却します、E/p>

Authorizations:

apiKey

path Parameters

mapSlug

required

string

Example: example_map

マップスラグ

query Parameters

locale

required

string (LocaleType)

Example: locale=ja

Responses

Response samples

200
400
401
403
404

Content type

application/json

[[{"id": 1234,
"title": "スポッチE",
"graphicMapFloorId": 42,
"createdAt": "2024-04-01T12:00:00.000Z",
"updatedAt": "2024-04-01T12:00:00.000Z"
},
{"id": 2345,
"title": "スポッチE",
"graphicMapFloorId": 42,
"createdAt": "2024-04-01T12:00:00.000Z",
"updatedAt": "2024-04-01T12:00:00.000Z"
},
{"id": 3456,
"title": "スポッチE",
"graphicMapFloorId": 43,
"createdAt": "2024-04-01T12:00:00.000Z",
"updatedAt": "2024-04-01T12:00:00.000Z"
},
{"id": 4567,
"title": "スポッチE",
"graphicMapFloorId": 47,
"createdAt": "2024-04-01T12:00:00.000Z",
"updatedAt": "2024-04-01T12:00:00.000Z"
}
]
]

スポット登録

スポットを新規登録します、E/p>

Authorizations:

apiKey

path Parameters

mapSlug

required

string

Example: example_map

マップスラグ

query Parameters

locale

required

string (LocaleType)

Example: locale=ja

Request Body schema: application/json

登録するスポット�E惁E��

	Array of objects <= 10 characters スポット�Eバナー惁E��
thumbnailImageUrl	string (url) <= 2000 characters
logoImageUrl	string (url) <= 2000 characters
markerImageUrl	string (url) <= 2000 characters
categoryIds required	Array of integers <int64> (id) [ items <int64 > ] カチE��リー一覧
pictgramIds	Array of integers <int64> (id) [ items <int64 > ] ピクトグラム一覧
tags	Array of strings ハッシュタグ一覧�E��E頭の # なし！E/p>
shareType required	integer <int32> (ShareType) Enum: 1 3 9 1:公閁E\| 3:非�E閁E\| 9:削除
latitude required	number 緯度�E�省略時、住所をジオコーチE��ング�E�E/p>
longitude required	number 経度�E�省略時、住所をジオコーチE��ング�E�E/p>
phoneNumber	string <= 30 characters 電話番号
effectiveFrom	string <date-time> (datetime)
effectiveTo	string <date-time> (datetime)
heldFrom	string <date-time> (datetime)
heldTo	string <date-time> (datetime)
postCode	string <= 7 characters 郵便番号�E�ハイフン不要E��E/p>
prefectureCode	string <= 5 characters 都道府県コーチE/p>
title required	string <= 100 characters タイトル
titleKana	string <= 200 characters タイトル検索用チE�Eタ�E�かな・カナなど�E�E/p>
subTitle	string <= 100 characters サブタイトルめE��ャチE��コピ�E
description	string <= 2000 characters スポット説明テキスチE/p>
address	string <= 200 characters 住所�E�フリーチE��スト！Eまた�E 住所ライン1
address2	string <= 100 characters 住所ライン2
webUrl	string (url) <= 2000 characters
businessHour	string <= 500 characters 営業時間
holiday	string <= 500 characters 休業日
parking	string <= 500 characters 駐車場
access	string <= 500 characters 交通手段、アクセス惁E��
fee	string <= 500 characters 入場料など料��
paymentMethod	string <= 500 characters 利用可能な支払い方況E/p>
	Array of objects
graphicMapFloorId required	integer <int64> (id)
floorDescription	string <= 500 characters フロア用説昁E/p>
listDescription	string <= 500 characters リスト用説昁E/p>
	object (SnsLinks) 吁E��SNSのリンク

Responses

Request samples

Payload

Content type

application/json

{"banners": [{"url": "https://floormap.digital/",
"mediaType": 1,
"caption": "バナー画像�EキャプションチE��ストです、Equot;
}
],
"thumbnailImageUrl": "https://floormap.digital/",
"logoImageUrl": "https://floormap.digital/",
"markerImageUrl": "https://floormap.digital/",
"categoryIds": [111,
222,
333
],
"pictgramIds": [444,
555,
666
],
"tags": ["カレー",
"寿司"
],
"shareType": 1,
"latitude": "99.99999999",
"longitude": "99.99999999",
"phoneNumber": "99-9999-9999",
"effectiveFrom": "2024-04-01T12:00:00.000Z",
"effectiveTo": "2024-04-01T12:00:00.000Z",
"heldFrom": "2024-04-01T12:00:00.000Z",
"heldTo": "2024-04-01T12:00:00.000Z",
"postCode": 1600023,
"prefectureCode": "JP-13",
"title": "サンプルスポット名称",
"titleKana": "サンプルスポッチEquot;,
"subTitle": "スポット�Eサブタイトルです、Equot;,
"description": "スポット�E説明テキストです、Equot;,
"address": "東京都新宿区西新宿3-9-7",
"address2": "フロンチE��ア新宿タワー 4F",
"webUrl": "https://floormap.digital/",
"businessHour": "月〜��曁E10:00 - 19:00",
"holiday": "土曜・日曜�E祝祭日",
"parking": "近隣にコインパ�Eキングあり",
"access": "JR新宿駁E��口より徒歩10刁Equot;,
"fee": "入場料　大人�E�E000冁E��小人�E�E00冁Equot;,
"paymentMethod": "現金、クレジチE��カード、交通系ICカード、PayPay、QUICPay",
"customProperties": [{"id": 1,
"description": "カスタム頁E���E�電話番号",
"value": "00-0000-0000"
},
{"id": 2,
"description": "カスタム頁E���E��E稁Equot;,
"value": "店頭で免税手続を承りまぁEquot;
},
{"id": 3,
"description": "カスタム頁E���E�ヒルズカーチEquot;,
"value": "ヒルズポイント対象/クレジチE��ポイント対象"
},
{"id": 4,
"description": "カスタム頁E���E�取扱ブランチEquot;,
"value": "PlatinaMalls, Platinumaps"
},
{"id": 5,
"description": "カスタム頁E���E�関連リンク",
"value": "https://boldright.co.jp"
},
{"id": 6,
"description": "カスタム頁E���E�座席数",
"value": "店�E�E�E0席"
},
{"id": 7,
"description": "カスタム頁E���E�平坁E��箁Equot;,
"value": "ランチE��￥10,000、ディナ�E�E�¥30,000"
}
],
"graphicMapFloorId": 42,
"floorDescription": "フロア用説明テキストです。場所の目印などが�Eります、Equot;,
"listDescription": "リスト用説明テキストです。店�Eの説明などが�Eります、Equot;,
"sns": {"twitter": "https://twitter.com/",
"youtube": "https://youtube.com/"
}
}

Response samples

200
400
401
403

Content type

application/json

{"spotId": 42,
"createdAt": "2024-04-01T12:00:00.000Z"
}

スポット詳細取征E!-- -->

スポット�E詳細惁E��を返却します、E/p>

Authorizations:

apiKey

path Parameters

mapSlug required	string Example: example_map マップスラグ
spotId required	integer <int64> (id) Example: 42 スポッチED

query Parameters

locale

required

string (LocaleType)

Example: locale=ja

Responses

Response samples

200
400
401
403
404

Content type

application/json

{"spotId": 42,
"locale": "ja",
"originalLocale": "ja",
"createdAt": "2024-04-01T12:00:00.000Z",
"updatedAt": "2024-04-01T12:00:00.000Z",
"banners": [{"mediaId": 42,
"url": "https://floormap.digital/",
"staticImageUrl": "https://floormap.digital/",
"width": 512,
"height": 512,
"mediaType": 1,
"caption": "string"
}
],
"thumbnailImageUrl": "https://floormap.digital/",
"logoImageUrl": "https://floormap.digital/",
"markerImageUrl": "https://floormap.digital/",
"markerIconWidth": 512,
"markerIconHeight": 512,
"categoryIds": [111,
222,
333
],
"pictgramIds": [444,
555,
666
],
"tags": ["カレー",
"寿司"
],
"shareType": 1,
"latitude": "99.99999999",
"longitude": "99.99999999",
"phoneNumber": "99-9999-9999",
"effectiveFrom": "2024-04-01T12:00:00.000Z",
"effectiveTo": "2024-04-01T12:00:00.000Z",
"heldFrom": "2024-04-01T12:00:00.000Z",
"heldTo": "2024-04-01T12:00:00.000Z",
"postCode": 1600023,
"prefectureCode": "JP-13",
"title": "サンプルスポット名称",
"titleKana": "サンプルスポッチEquot;,
"subTitle": "スポット�Eサブタイトルです、Equot;,
"description": "スポット�E説明テキストです、Equot;,
"address": "東京都新宿区西新宿3-9-7",
"address2": "フロンチE��ア新宿タワー 4F",
"webUrl": "https://floormap.digital/",
"businessHour": "月〜��曁E10:00 - 19:00",
"holiday": "土曜・日曜�E祝祭日",
"parking": "近隣にコインパ�Eキングあり",
"access": "JR新宿駁E��口より徒歩10刁Equot;,
"fee": "入場料　大人�E�E000冁E��小人�E�E00冁Equot;,
"paymentMethod": "現金、クレジチE��カード、交通系ICカード、PayPay、QUICPay",
"customProperties": [{"id": 1,
"description": "カスタム頁E���E�電話番号",
"value": "00-0000-0000"
},
{"id": 2,
"description": "カスタム頁E���E��E稁Equot;,
"value": "店頭で免税手続を承りまぁEquot;
},
{"id": 3,
"description": "カスタム頁E���E�ヒルズカーチEquot;,
"value": "ヒルズポイント対象/クレジチE��ポイント対象"
},
{"id": 4,
"description": "カスタム頁E���E�取扱ブランチEquot;,
"value": "PlatinaMalls, Platinumaps"
},
{"id": 5,
"description": "カスタム頁E���E�関連リンク",
"value": "https://boldright.co.jp"
},
{"id": 6,
"description": "カスタム頁E���E�座席数",
"value": "店�E�E�E0席"
},
{"id": 7,
"description": "カスタム頁E���E�平坁E��箁Equot;,
"value": "ランチE��￥10,000、ディナ�E�E�¥30,000"
}
],
"graphicMapFloorId": 42,
"floorDescription": "フロア用説明テキストです。場所の目印などが�Eります、Equot;,
"listDescription": "リスト用説明テキストです。店�Eの説明などが�Eります、Equot;,
"sns": {"twitter": "https://twitter.com/",
"youtube": "https://youtube.com/"
}
}

スポット更新

持E��したスポット�E惁E��を更新します、E/p>

Authorizations:

apiKey

path Parameters

mapSlug required	string Example: example_map マップスラグ
spotId required	integer <int64> (id) Example: 42 スポッチED

query Parameters

locale

required

string (LocaleType)

Example: locale=ja

Request Body schema: application/json

spotId required	integer <int64> (id)
locale required	string (LocaleType) `ja`:日本誁E\| `en`:英誁E\| `zh-Hans`:簡体孁E\| `ko`:韓国誁E\| `zh-Hant`:繁体孁E\| `fr`:フランス誁E\| `es`:スペイン誁E/p>
	Array of objects <= 10 characters スポット�Eバナー惁E��E�削除するバナーの惁E��は含めなぁE��E/p>
thumbnailImageUrl	string (url) <= 2000 characters
logoImageUrl	string (url) <= 2000 characters
markerImageUrl	string (url) <= 2000 characters
categoryIds required	Array of integers <int64> (id) [ items <int64 > ] カチE��リー一覧
pictgramIds	Array of integers <int64> (id) [ items <int64 > ] ピクトグラム一覧
tags	Array of strings ハッシュタグ一覧�E��E頭の # 不要E��E/p>
shareType required	integer <int32> (ShareType) Enum: 1 3 9 1:公閁E\| 3:非�E閁E\| 9:削除
latitude	number 緯度�E�省略時、住所をジオコーチE��ング�E�E/p>
longitude	number 経度�E�省略時、住所をジオコーチE��ング�E�E/p>
phoneNumber	string <= 30 characters 電話番号
effectiveFrom	string <date-time> (datetime)
effectiveTo	string <date-time> (datetime)
heldFrom	string <date-time> (datetime)
heldTo	string <date-time> (datetime)
postCode	string <= 7 characters 郵便番号�E�ハイフン不要E��E/p>
prefectureCode	string <= 5 characters 都道府県コーチE/p>
title required	string <= 100 characters タイトル
titleKana	string <= 200 characters タイトル検索用チE�Eタ�E�かな・カナなど�E�E/p>
subTitle	string <= 100 characters サブタイトルめE��ャチE��コピ�E
description	string <= 2000 characters スポット説明テキスチE/p>
address required	string <= 200 characters 住所�E�フリーチE��スト！Eまた�E 住所ライン1
address2	string <= 100 characters 住所ライン2
webUrl	string (url) <= 2000 characters
businessHour	string <= 500 characters 営業時間
holiday	string <= 500 characters 休業日
parking	string <= 500 characters 駐車場
access	string <= 500 characters 交通手段、アクセス惁E��
fee	string <= 500 characters 入場料など料��
paymentMethod	string <= 500 characters 利用可能な支払い方況E/p>
	Array of objects
graphicMapFloorId	integer <int64> (id)
floorDescription	string <= 500 characters フロア用説昁E/p>
listDescription	string <= 500 characters リスト用説昁E/p>
	object (SnsLinks) 吁E��SNSのリンク

Responses

Request samples

Payload

Content type

application/json

{"spotId": 42,
"locale": "ja",
"banners": [{"mediaId": 42,
"url": "https://floormap.digital/",
"mediaType": 1,
"caption": "string"
}
],
"thumbnailImageUrl": "https://floormap.digital/",
"logoImageUrl": "https://floormap.digital/",
"markerImageUrl": "https://floormap.digital/",
"categoryIds": [111,
222,
333
],
"pictgramIds": [444,
555,
666
],
"tags": ["カレー",
"寿司"
],
"shareType": 1,
"latitude": "99.99999999",
"longitude": "99.99999999",
"phoneNumber": "99-9999-9999",
"effectiveFrom": "2024-04-01T12:00:00.000Z",
"effectiveTo": "2024-04-01T12:00:00.000Z",
"heldFrom": "2024-04-01T12:00:00.000Z",
"heldTo": "2024-04-01T12:00:00.000Z",
"postCode": 1600023,
"prefectureCode": "JP-13",
"title": "サンプルスポット名称",
"titleKana": "サンプルスポッチEquot;,
"subTitle": "スポット�Eサブタイトルです、Equot;,
"description": "スポット�E説明テキストです、Equot;,
"address": "東京都新宿区西新宿3-9-7",
"address2": "フロンチE��ア新宿タワー 4F",
"webUrl": "https://floormap.digital/",
"businessHour": "月〜��曁E10:00 - 19:00",
"holiday": "土曜・日曜�E祝祭日",
"parking": "近隣にコインパ�Eキングあり",
"access": "JR新宿駁E��口より徒歩10刁Equot;,
"fee": "入場料　大人�E�E000冁E��小人�E�E00冁Equot;,
"paymentMethod": "現金、クレジチE��カード、交通系ICカード、PayPay、QUICPay",
"customProperties": [{"id": 1,
"description": "カスタム頁E���E�電話番号",
"value": "00-0000-0000"
},
{"id": 2,
"description": "カスタム頁E���E��E稁Equot;,
"value": "店頭で免税手続を承りまぁEquot;
},
{"id": 3,
"description": "カスタム頁E���E�ヒルズカーチEquot;,
"value": "ヒルズポイント対象/クレジチE��ポイント対象"
},
{"id": 4,
"description": "カスタム頁E���E�取扱ブランチEquot;,
"value": "PlatinaMalls, Platinumaps"
},
{"id": 5,
"description": "カスタム頁E���E�関連リンク",
"value": "https://boldright.co.jp"
},
{"id": 6,
"description": "カスタム頁E���E�座席数",
"value": "店�E�E�E0席"
},
{"id": 7,
"description": "カスタム頁E���E�平坁E��箁Equot;,
"value": "ランチE��￥10,000、ディナ�E�E�¥30,000"
}
],
"graphicMapFloorId": 42,
"floorDescription": "フロア用説明テキストです。場所の目印などが�Eります、Equot;,
"listDescription": "リスト用説明テキストです。店�Eの説明などが�Eります、Equot;,
"sns": {"twitter": "https://twitter.com/",
"youtube": "https://youtube.com/"
}
}

Response samples

200
400
401
403
404

Content type

application/json

{"spotId": 42,
"updatedAt": "2024-04-01T12:00:00.000Z"
}

スポット削除

持E��したスポットを削除します、E/p>

Authorizations:

apiKey

path Parameters

mapSlug required	string Example: example_map マップスラグ
spotId required	integer <int64> (id) Example: 42 スポッチED

Responses

Response samples

400
401
403
404

Content type

application/json

{"code": 400,
"message": "冁E��エラーが発生しました、Equot;
}

スポット混雑状況更新

スポット�E混雑状況を更新します、E/p>

Authorizations:

apiKey

path Parameters

mapSlug required	string Example: example_map マップスラグ
spotId required	integer <int64> (id) Example: 42 スポッチED

Request Body schema: application/json

混雑状況E/p>

spotId required	number スポッチED
required	object (UpdateCrowdStatus)

Responses

Request samples

Payload

Content type

application/json

{"spotId": 123,
"crowdStatus": {"status": 0,
"isVisible": true,
"imageUrl": "https://floormap.digital/"
}
}

Response samples

400
401
403
404

Content type

application/json

{"code": 400,
"message": "冁E��エラーが発生しました、Equot;
}

スポット征E��時間状況更新

スポット�E征E��時間状況を更新します、E/p>

Authorizations:

apiKey

path Parameters

mapSlug required	string Example: example_map マップスラグ
spotId required	integer <int64> (id) Example: 42 スポッチED

Request Body schema: application/json

征E��時間状況E/p>

spotId required	number スポッチED
	object (UpdateWaitingTimeStatus)

Responses

Request samples

Payload

Content type

application/json

{"spotId": 123,
"WaitingTimeStatus": {"waitingTime": 30,
"WaitingTimeType": 0,
"isVisible": true
}
}

Response samples

400
401
403
404

Content type

application/json

{"code": 400,
"message": "冁E��エラーが発生しました、Equot;
}

スポット一覧差刁E��征E!-- -->

持E��した日時以降に更新のあったスポット�E惁E��を返却します、E/p>

Authorizations:

apiKey

path Parameters

mapSlug

required

string

Example: example_map

マップスラグ

query Parameters

from required	string <date-time> (datetime) Example: from=2024-04-01T12:00:00.000Z 更新日晁EROM
to	string <date-time> (datetime) Example: to=2024-04-01T12:00:00.000Z 更新日時TO

Responses

Response samples

200
400
401
403

Content type

application/json

{"spots": [{"spotId": 123,
"shareType": 1,
"updatedAt": "2024-04-01T12:00:00.000Z"
}
]
}

floors

フロア惁E��を扱ぁEPIカチE��リです、E/p>

フロア一覧

持E��した�EチE�EIDにおけるフロアの一覧を返却します、E/p>

Authorizations:

apiKey

path Parameters

mapSlug

required

string

Example: example_map

マップスラグ

Responses

Response samples

200
400
401
403
404

Content type

application/json

[{"id": 123,
"name": "1F",
"createdAt": "2024-04-01T12:00:00.000Z",
"updatedAt": "2024-04-01T12:00:00.000Z"
},
{"id": 456,
"name": "2F",
"createdAt": "2024-04-01T12:00:00.000Z",
"updatedAt": "2024-04-01T12:00:00.000Z"
},
{"id": 789,
"name": "3F",
"createdAt": "2024-04-01T12:00:00.000Z",
"updatedAt": "2024-04-01T12:00:00.000Z"
}
]