プラチナマップ以外のCMS（以下、外部CMS）で管理しているスポットと、プラチナマップで管理しているスポットを連携するためのAPIです。
プラチナマップをご利用のお客様においてWebサイトのCMSやその他の管理システムをお持ちの場合、このAPIをご活用いただくことでプラチナマップのスポット情報と連携し、外部Webサイトとプラチナマップの間でシームレスな情報更新が可能となります。
- スポットを登録する
- スポットの多言語情報を登録する
- スポットの混雑状況を登録する
- スポットの情報を更新する
- スポットを非公開にする
- スポットを削除する
1. スポットを登録する
外部CMSでスポットを登録した際などに、スポット登録APIを呼び出してください。
対象マップを指定するマップスラグはマップURLからご確認いただけます。
（マップURLが https://platinumaps.jp/d/XXXXXXXX の場合：XXXXXXXXがマップスラグを指します。）
登録・更新の際に必要となるカスタム項目ID CustomPropertyId、カテゴリID CategoryId、ピクトグラムID PictgramIdはプラチナマップの管理画面にてご確認ください。
2. スポットの多言語情報を登録する
登録したスポットに対して、例えば英語のデータを追加したい時などは、スポット更新APIを呼び出してください。
何語のデータであるかは locale で指定します。（ja:日本語 | en:英語 | zh-Hans:簡体字 | ko:韓国語 | zh-Hant:繁体字 | fr:フランス語 | es:スペイン語）
※ 言語によらず共通である項目（例: 緯度、経度など）も同時に更新対象となるため、更新したくない必須項目に対しては、スポット詳細取得APIで取得した値を設定してください。
3. スポットの混雑状況を登録する
登録したスポットの混雑状況を登録または更新する場合は、スポット混雑状況更新APIを呼び出してください。
4. スポットの情報を更新する
外部CMSでスポットを更新した際などに、スポット更新APIを呼び出してください。
5. スポットを非公開にする
外部CMSでスポットを一時的に削除した際など（削除からの取り戻しが可能である場合）に、スポット更新APIを利用して、スポットのデータを維持したまま、非公開状態にすることができます。
再び公開する場合もスポット更新APIを利用してください。
6. スポットを削除する
外部CMSでスポットを完全に削除した際などに、スポット削除APIを呼び出してください。
スポット一覧
指定したマップIDにおけるスポットの一覧を返却します。
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": "スポットA",
- "createdAt": "2024-04-01T12:00:00.000Z",
- "updatedAt": "2024-04-01T12:00:00.000Z"
}, - {
- "id": 2345,
- "title": "スポットB",
- "createdAt": "2024-04-01T12:00:00.000Z",
- "updatedAt": "2024-04-01T12:00:00.000Z"
}, - {
- "id": 3456,
- "title": "スポットC",
- "createdAt": "2024-04-01T12:00:00.000Z",
- "updatedAt": "2024-04-01T12:00:00.000Z"
}, - {
- "id": 4567,
- "title": "スポットD",
- "createdAt": "2024-04-01T12:00:00.000Z",
- "updatedAt": "2024-04-01T12:00:00.000Z"
}
]
]スポット登録
スポットを新規登録します。
Authorizations:
apiKey
path Parameters
| mapSlug required | string Example: example_map マップスラグ |
query Parameters
| locale required | string (LocaleType) Example: locale=ja 取得対象の言語( |
Request Body schema: application/json
登録するスポットの情報
Array of objects <= 10 characters スポットのバナー情報 | |
| thumbnailImageUrl | string (url) <= 2000 characters |
| logoImageUrl | string (url) <= 2000 characters |
| markerImageUrl | string (url) <= 2000 characters |
| categoryIds required | Array of integers <int64> (id) [ items <int64 > ] カテゴリー一覧 |
| pictgramIds | Array of integers <int64> (id) [ items <int64 > ] ピクトグラム一覧 |
| tags | Array of strings ハッシュタグ一覧（先頭の # なし） |
| shareType required | integer <int32> (ShareType) Enum: 1 3 9 1:公開 | 3:非公開 | 9:削除 |
| latitude required | number 緯度（省略時、住所をジオコーディング） |
| longitude required | number 経度（省略時、住所をジオコーディング） |
| 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 郵便番号（ハイフン不要） |
| prefectureCode | string <= 5 characters 都道府県コード |
| title required | string <= 100 characters タイトル |
| titleKana | string <= 200 characters タイトル検索用データ（かな・カナなど） |
| subTitle | string <= 100 characters サブタイトルやキャッチコピー |
| description | string <= 2000 characters スポット説明テキスト |
| address | string <= 200 characters 住所（フリーテキスト） または 住所ライン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 交通手段、アクセス情報 |
| fee | string <= 500 characters 入場料など料金 |
| paymentMethod | string <= 500 characters 利用可能な支払い方法 |
Array of objects | |
| listDescription | string <= 500 characters リスト用説明 |
object (SnsLinks) 各種SNSのリンク |
Responses
Request samples
- Payload
Content type
application/json
{- "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": "サンプルスポット",
- "subTitle": "スポットのサブタイトルです。",
- "description": "スポットの説明テキストです。",
- "address": "東京都新宿区西新宿3-9-7",
- "address2": "フロンティア新宿タワー 4F",
- "businessHour": "月〜金曜 10:00 - 19:00",
- "holiday": "土曜・日曜・祝祭日",
- "parking": "近隣にコインパーキングあり",
- "access": "JR新宿駅西口より徒歩10分",
- "fee": "なし",
- "paymentMethod": "現金、クレジッドカード、交通系ICカード",
- "customProperties": [
- {
- "id": 1,
- "description": "カスタム項目：電話番号",
- "value": "00-0000-0000"
}, - {
- "id": 2,
- "description": "カスタム項目：免税",
- "value": "店頭で免税手続を承ります"
}, - {
- "id": 3,
- "description": "カスタム項目：ポイントカード",
- "value": "ポイント対象"
}, - {
- "id": 4,
- "description": "カスタム項目：取扱ブランド",
- "value": "Metamap, Platinumaps"
}, - {
- "id": 6,
- "description": "カスタム項目：座席数",
- "value": "店内：10席"
}, - {
- "id": 7,
- "description": "カスタム項目：平均予算",
- "value": "ランチ：￥2,000、ディナー：¥10,000"
}
], - "listDescription": "リスト用説明テキストです。店舗の説明などが入ります。",
}Response samples
- 200
- 400
- 401
- 403
Content type
application/json
{- "spotId": 42,
- "createdAt": "2024-04-01T12:00:00.000Z"
}スポット詳細取得
スポットの詳細情報を返却します。
Authorizations:
apiKey
path Parameters
| mapSlug required | string Example: example_map マップスラグ |
| spotId required | integer <int64> (id) Example: 42 スポットID |
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,
- "width": 512,
- "height": 512,
- "mediaType": 1,
- "caption": "string"
}
], - "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": "サンプルスポット",
- "subTitle": "スポットのサブタイトルです。",
- "description": "スポットの説明テキストです。",
- "address": "東京都新宿区西新宿3-9-7",
- "address2": "フロンティア新宿タワー 4F",
- "businessHour": "月〜金曜 10:00 - 19:00",
- "holiday": "土曜・日曜・祝祭日",
- "parking": "近隣にコインパーキングあり",
- "access": "JR新宿駅西口より徒歩10分",
- "fee": "なし",
- "paymentMethod": "現金、クレジッドカード、交通系ICカード",
- "customProperties": [
- {
- "id": 1,
- "description": "カスタム項目：電話番号",
- "value": "00-0000-0000"
}, - {
- "id": 2,
- "description": "カスタム項目：免税",
- "value": "店頭で免税手続を承ります"
}, - {
- "id": 3,
- "description": "カスタム項目：ポイントカード",
- "value": "ポイント対象"
}, - {
- "id": 4,
- "description": "カスタム項目：取扱ブランド",
- "value": "Metamap, Platinumaps"
}, - {
- "id": 6,
- "description": "カスタム項目：座席数",
- "value": "店内：10席"
}, - {
- "id": 7,
- "description": "カスタム項目：平均予算",
- "value": "ランチ：￥2,000、ディナー：¥10,000"
}
], - "listDescription": "リスト用説明テキストです。店舗の説明などが入ります。",
}スポット更新
指定したスポットの情報を更新します。
Authorizations:
apiKey
path Parameters
| mapSlug required | string Example: example_map マップスラグ |
| spotId required | integer <int64> (id) Example: 42 スポットID |
query Parameters
| locale required | string (LocaleType) Example: locale=ja 取得対象の言語( |
Request Body schema: application/json
| spotId required | integer <int64> (id) |
| locale required | string (LocaleType)
|
Array of objects <= 10 characters スポットのバナー情報（削除するバナーの情報は含めない） | |
| thumbnailImageUrl | string (url) <= 2000 characters |
| logoImageUrl | string (url) <= 2000 characters |
| markerImageUrl | string (url) <= 2000 characters |
| categoryIds required | Array of integers <int64> (id) [ items <int64 > ] カテゴリー一覧 |
| pictgramIds | Array of integers <int64> (id) [ items <int64 > ] ピクトグラム一覧 |
| tags | Array of strings ハッシュタグ一覧（先頭の # 不要） |
| shareType required | integer <int32> (ShareType) Enum: 1 3 9 1:公開 | 3:非公開 | 9:削除 |
| latitude | number 緯度（省略時、住所をジオコーディング） |
| longitude | number 経度（省略時、住所をジオコーディング） |
| 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 郵便番号（ハイフン不要） |
| prefectureCode | string <= 5 characters 都道府県コード |
| title required | string <= 100 characters タイトル |
| titleKana | string <= 200 characters タイトル検索用データ（かな・カナなど） |
| subTitle | string <= 100 characters サブタイトルやキャッチコピー |
| description | string <= 2000 characters スポット説明テキスト |
| address required | string <= 200 characters 住所（フリーテキスト） または 住所ライン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 交通手段、アクセス情報 |
| fee | string <= 500 characters 入場料など料金 |
| paymentMethod | string <= 500 characters 利用可能な支払い方法 |
Array of objects | |
| listDescription | string <= 500 characters リスト用説明 |
object (SnsLinks) 各種SNSのリンク |
Responses
Request samples
- Payload
Content type
application/json
{- "spotId": 42,
- "locale": "ja",
- "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": "サンプルスポット",
- "subTitle": "スポットのサブタイトルです。",
- "description": "スポットの説明テキストです。",
- "address": "東京都新宿区西新宿3-9-7",
- "address2": "フロンティア新宿タワー 4F",
- "businessHour": "月〜金曜 10:00 - 19:00",
- "holiday": "土曜・日曜・祝祭日",
- "parking": "近隣にコインパーキングあり",
- "access": "JR新宿駅西口より徒歩10分",
- "fee": "なし",
- "paymentMethod": "現金、クレジッドカード、交通系ICカード",
- "customProperties": [
- {
- "id": 1,
- "description": "カスタム項目：電話番号",
- "value": "00-0000-0000"
}, - {
- "id": 2,
- "description": "カスタム項目：免税",
- "value": "店頭で免税手続を承ります"
}, - {
- "id": 3,
- "description": "カスタム項目：ポイントカード",
- "value": "ポイント対象"
}, - {
- "id": 4,
- "description": "カスタム項目：取扱ブランド",
- "value": "Metamap, Platinumaps"
}, - {
- "id": 6,
- "description": "カスタム項目：座席数",
- "value": "店内：10席"
}, - {
- "id": 7,
- "description": "カスタム項目：平均予算",
- "value": "ランチ：￥2,000、ディナー：¥10,000"
}
], - "listDescription": "リスト用説明テキストです。店舗の説明などが入ります。",
}Response samples
- 200
- 400
- 401
- 403
- 404
Content type
application/json
{- "spotId": 42,
- "updatedAt": "2024-04-01T12:00:00.000Z"
}スポット混雑状況更新
スポットの混雑状況を更新します。
Authorizations:
apiKey
path Parameters
| mapSlug required | string Example: example_map マップスラグ |
| spotId required | integer <int64> (id) Example: 42 スポットID |
Request Body schema: application/json
混雑状況
| spotId required | number スポットID |
required | object (UpdateCrowdStatus) |
Responses
Request samples
- Payload
Content type
application/json
{- "spotId": 123,
}Response samples
- 400
- 401
- 403
- 404
Content type
application/json
{- "code": 400,
- "message": "内部エラーが発生しました。"
}スポット待ち時間状況更新
スポットの待ち時間状況を更新します。
Authorizations:
apiKey
path Parameters
| mapSlug required | string Example: example_map マップスラグ |
| spotId required | integer <int64> (id) Example: 42 スポットID |
Request Body schema: application/json
待ち時間状況
| spotId required | number スポットID |
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": "内部エラーが発生しました。"
}スポット一覧差分取得
指定した日時以降に更新のあったスポットの情報を返却します。
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 更新日時FROM |
| 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"
}
]
}