API docs by Redocly

Platinumaps API (1.0.0)

Download OpenAPI specification:Download

URL: https://platinumaps.jp/#inquiry License: Boldright, Inc.

概要

プラチナマップ以外のCMS（以下、外部CMS）で管理しているスポットと、プラチナマップで管理しているスポットを連携するためのAPIです。

データ連携の流れ

  1. スポットを登録する
  2. スポットの多言語情報を登録する
  3. スポットの混雑状況を登録する
  4. スポットの情報を更新する
  5. スポットを非公開にする
  6. スポットを削除する

1. スポットを登録する

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

スポットIDの紐付け

スポット登録APIから返却された spotId （プラチナマップ上のスポットID）を、外部CMS上のスポット情報と紐付けて保存してください。 当該スポットに対して更新や削除を行う際に必要になります。

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

登録したスポットに対して、例えば英語のデータを追加したい時などは、スポット更新APIを呼び出してください。
何語のデータであるかは locale で指定します。

※ 言語によらず共通である項目（例: 緯度、経度など）も同時に更新対象となるため、更新したくない項目に対しては、スポット詳細取得APIで取得した値を設定してください。

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

登録したスポットの混雑状況を登録または更新する場合は、スポット混雑状況更新APIを呼び出してください。

4. スポットの情報を更新する

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

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

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

6. スポットを削除する

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

認証方式

発行されたAPIキーをHTTPヘッダの Platinumaps-Api-Key に設定してください。

spots

スポット情報

スポット一覧取得

マップに登録されたすべてのスポットの情報を返却します。

Authorizations:
apiKey
header Parameters
Platinumaps-Map-Slug
string
Example: yourmapslug

マップスラグ

Responses

Response samples

Content type
application/json
{
  • "spots": [
    ]
}

スポット登録

スポットを新規登録します。

Authorizations:
apiKey
header Parameters
Platinumaps-Map-Slug
string
Example: yourmapslug

マップスラグ

Request Body schema: application/json
required

登録するスポットの情報

locale
required
integer <int32> (LocaleType)
Enum: 1 2 3 4 5 6 7 8 9 10 11

言語指定 1:日本語 | 2:英語 | 3:簡体字 | 4:韓国語 | 5:繁体字 | 6:フランス語 | 7:スペイン語 | 8:ベトナム語 | 9:インドネシア語 | 10:ミャンマー語 | 11:タイ語

Array of objects <= 10 characters

スポット画像

logoImageUrl
string (url) <= 2000 characters

URL文字列

markerImageUrl
string (url) <= 2000 characters

URL文字列

categoryIds
Array of integers <int64> [ items <int64 > ]

カテゴリー

pictgramIds
Array of integers <int64> [ items <int64 > ]

ピクトグラム

tags
Array of strings

タグ

shareType
required
integer <int32> (ShareType)

公開設定 1:公開 | 3:非公開 | 9:削除

latitude
number

緯度

longitude
number

経度

effectiveFrom
string <date-time> (datetime)

日時文字列（UTC）

effectiveTo
string <date-time> (datetime)

日時文字列（UTC）

heldFrom
string <date-time> (datetime)

日時文字列（UTC）

heldTo
string <date-time> (datetime)

日時文字列（UTC）

postCode
string <= 7 characters

郵便番号

prefectureCode
string <= 5 characters

都道府県コード

title
required
string <= 500 characters

スポット・施設名

titleKana
string <= 200 characters

検索キーワード

subTitle
string <= 500 characters

サブタイトル

description
string <= 4000 characters

説明

address
string <= 1000 characters

住所

address2
string <= 100 characters

住所ライン2

phoneNumber
string <= 500 characters

電話番号

webUrl
string (url) <= 2000 characters

URL文字列

businessHour
string <= 2000 characters

営業時間

holiday
string <= 2000 characters

休業日

parking
string <= 2000 characters

駐車場

access
string <= 2000 characters

アクセス

fee
string <= 2000 characters

料金

paymentMethod
string <= 2000 characters

お支払い方法

remarks
string <= 2000 characters

備考

Array of objects

詳細項目一覧

object (SnsLinks)

各種SNSのリンク

Responses

Request samples

Content type
application/json
{
  • "locale": 1,
  • "banners": [
    ],
  • "logoImageUrl": "string",
  • "markerImageUrl": "string",
  • "categoryIds": [
    ],
  • "pictgramIds": [
    ],
  • "tags": [
    ],
  • "shareType": 1,
  • "latitude": 0,
  • "longitude": 0,
  • "effectiveFrom": "2019-08-24T14:15:22Z",
  • "effectiveTo": "2019-08-24T14:15:22Z",
  • "heldFrom": "2019-08-24T14:15:22Z",
  • "heldTo": "2019-08-24T14:15:22Z",
  • "postCode": "string",
  • "prefectureCode": "JP-13",
  • "title": "string",
  • "titleKana": "string",
  • "subTitle": "string",
  • "description": "string",
  • "address": "string",
  • "address2": "string",
  • "phoneNumber": "string",
  • "webUrl": "string",
  • "businessHour": "string",
  • "holiday": "string",
  • "parking": "string",
  • "access": "string",
  • "fee": "string",
  • "paymentMethod": "string",
  • "remarks": "string",
  • "customProperties": [
    ],
  • "sns": {
    }
}

Response samples

Content type
application/json
{
  • "spotId": 0,
  • "createdAt": "2019-08-24T14:15:22Z"
}

スポット詳細取得

スポットの詳細情報を返却します。

Authorizations:
apiKey
path Parameters
spotId
required
integer <int64>
Example: 123

スポットID

query Parameters
locale
integer <int32> (LocaleType)
Enum: 1 2 3 4 5 6 7 8 9 10 11
Example: locale=1

言語指定

header Parameters
Platinumaps-Map-Slug
string
Example: yourmapslug

マップスラグ

Responses

Response samples

Content type
application/json
{
  • "spotId": 0,
  • "locale": 1,
  • "originalLocale": 1,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "banners": [
    ],
  • "thumbnailImageUrl": "string",
  • "logoImageUrl": "string",
  • "markerImageUrl": "string",
  • "markerIconWidth": 0,
  • "markerIconHeight": 0,
  • "categoryIds": [
    ],
  • "pictgramIds": [
    ],
  • "tags": [
    ],
  • "shareType": 1,
  • "latitude": 0,
  • "longitude": 0,
  • "effectiveFrom": "2019-08-24T14:15:22Z",
  • "effectiveTo": "2019-08-24T14:15:22Z",
  • "heldFrom": "2019-08-24T14:15:22Z",
  • "heldTo": "2019-08-24T14:15:22Z",
  • "postCode": "string",
  • "prefectureCode": "strin",
  • "title": "string",
  • "titleKana": "string",
  • "subTitle": "string",
  • "description": "string",
  • "address": "string",
  • "address2": "string",
  • "phoneNumber": "string",
  • "webUrl": "string",
  • "businessHour": "string",
  • "holiday": "string",
  • "parking": "string",
  • "access": "string",
  • "fee": "string",
  • "paymentMethod": "string",
  • "remarks": "string",
  • "customProperties": [
    ],
  • "sns": {
    }
}

スポット更新

指定したスポットの情報を更新します。

Authorizations:
apiKey
path Parameters
spotId
required
integer <int64>
Example: 123

スポットID

header Parameters
Platinumaps-Map-Slug
string
Example: yourmapslug

マップスラグ

Request Body schema: application/json
required
spotId
required
integer <int64>

更新対象のスポットID

locale
required
integer <int32> (LocaleType)
Enum: 1 2 3 4 5 6 7 8 9 10 11

言語指定 1:日本語 | 2:英語 | 3:簡体字 | 4:韓国語 | 5:繁体字 | 6:フランス語 | 7:スペイン語 | 8:ベトナム語 | 9:インドネシア語 | 10:ミャンマー語 | 11:タイ語

Array of objects <= 10 characters

スポット画像（削除するバナーの情報は含めない）

logoImageUrl
string (url) <= 2000 characters

URL文字列

markerImageUrl
string (url) <= 2000 characters

URL文字列

categoryIds
Array of integers <int64> [ items <int64 > ]

カテゴリー

pictgramIds
Array of integers <int64> [ items <int64 > ]

ピクトグラム

tags
Array of strings

ハッシュタグ一覧（先頭の # 不要）

shareType
required
integer <int32> (ShareType)

公開設定 1:公開 | 3:非公開 | 9:削除

latitude
number

緯度

longitude
number

経度

effectiveFrom
string <date-time> (datetime)

日時文字列（UTC）

effectiveTo
string <date-time> (datetime)

日時文字列（UTC）

heldFrom
string <date-time> (datetime)

日時文字列（UTC）

heldTo
string <date-time> (datetime)

日時文字列（UTC）

postCode
string <= 7 characters

郵便番号

prefectureCode
string <= 5 characters

都道府県コード

title
required
string <= 500 characters

スポット・施設名

titleKana
string <= 200 characters

検索キーワード

subTitle
string <= 500 characters

サブタイトル

description
string <= 4000 characters

説明

address
string <= 1000 characters

住所

address2
string <= 100 characters

住所ライン2

phoneNumber
string <= 500 characters

電話番号

webUrl
string (url) <= 2000 characters

URL文字列

businessHour
string <= 2000 characters

営業時間

holiday
string <= 2000 characters

休業日

parking
string <= 2000 characters

駐車場

access
string <= 2000 characters

アクセス

fee
string <= 2000 characters

料金

paymentMethod
string <= 2000 characters

利用可能な支払い方法

remarks
string <= 2000 characters

備考

Array of objects

詳細項目一覧

object (SnsLinks)

各種SNSのリンク

Responses

Request samples

Content type
application/json
{
  • "spotId": 123,
  • "locale": 1,
  • "banners": [
    ],
  • "logoImageUrl": "string",
  • "markerImageUrl": "string",
  • "categoryIds": [
    ],
  • "pictgramIds": [
    ],
  • "tags": [
    ],
  • "shareType": 1,
  • "latitude": 0,
  • "longitude": 0,
  • "effectiveFrom": "2019-08-24T14:15:22Z",
  • "effectiveTo": "2019-08-24T14:15:22Z",
  • "heldFrom": "2019-08-24T14:15:22Z",
  • "heldTo": "2019-08-24T14:15:22Z",
  • "postCode": "string",
  • "prefectureCode": "strin",
  • "title": "string",
  • "titleKana": "string",
  • "subTitle": "string",
  • "description": "string",
  • "address": "string",
  • "address2": "string",
  • "phoneNumber": "string",
  • "webUrl": "string",
  • "businessHour": "string",
  • "holiday": "string",
  • "parking": "string",
  • "access": "string",
  • "fee": "string",
  • "paymentMethod": "string",
  • "remarks": "string",
  • "customProperties": [
    ],
  • "sns": {
    }
}

Response samples

Content type
application/json
{
  • "spotId": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

スポット削除

指定したスポットを削除します。

Authorizations:
apiKey
path Parameters
spotId
required
integer <int64>
Example: 123

スポットID

header Parameters
Platinumaps-Map-Slug
string
Example: yourmapslug

マップスラグ

Responses

Response samples

Content type
application/json
{ }

スポット混雑状況登録

スポットの混雑状況または待ち時間の設定を行う。

Authorizations:
apiKey
header Parameters
Platinumaps-Map-Slug
string
Example: yourmapslug

マップスラグ

Request Body schema: application/json
required

スポット混雑状況

spotId
required
integer <int64>

設定対象のスポットID

statusType
required
integer <int32>
Enum: 0 1

混雑区分 0:混雑情報 | 1:待ち時間

crowdStatusConfigId
integer <int64>

混雑状況設定ID（混雑区分が0の時必須）

crowdStatusLevel
integer <int32>

混雑状況設定IDの設定におけるレベルを指定（例. 3:混雑 など）

waitingTimeType
integer <int32>
Enum: 0 1 2

待ち時間区分 0:分待ち | 1:分以内 | 2:分以上（混雑区分が1の時必須）

waitingTime
integer <int32>

待ち時間（分）（混雑区分が1の時必須）

Responses

Request samples

Content type
application/json
{
  • "spotId": 123,
  • "statusType": 0,
  • "crowdStatusConfigId": 44,
  • "crowdStatusLevel": 3,
  • "waitingTimeType": null,
  • "waitingTime": null
}

Response samples

Content type
application/json
{ }

スポット一覧差分取得

更新日時が指定した期間内であるスポットの情報を返却します。

Authorizations:
apiKey
query Parameters
from
required
string <date-time> (datetime)

更新日時FROM

to
string <date-time> (datetime)

更新日時TO

header Parameters
Platinumaps-Map-Slug
string
Example: yourmapslug

マップスラグ

Responses

Response samples

Content type
application/json
{
  • "spots": [
    ]
}