Platinumaps API (1.2.0)

Download OpenAPI specification:

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

Overview

This API enables the integration of spots managed in external CMSs (i.e., CMSs other than Platinum Map) with those managed in Platinumaps.

Data Integration Flow

Register a spot
Register multilingual information for a spot
Register congestion status for a spot
Update spot information
Set a spot to private
Delete a spot

1. Register a Spot

When a spot is registered in the external CMS, call the Spot Registration API.

Spot ID Mapping

Save the spotId (the spot ID in Platinumaps) returned by the Spot Registration API, mapped to the spot information in the external CMS. This ID will be required when updating or deleting the spot.

2. Register Multilingual Information for a Spot

To add data in another language (e.g., Chinese) for a registered spot, call the Spot Update API. Specify the language using the locale parameter.

※ Note: Fields that are common across languages (e.g., latitude, longitude) are also subject to update. For fields that you do not wish to update, use the values retrieved via the Spot Details API.

3. Register Congestion Status for a Spot

To register or update congestion status for a registered spot, call the Spot Congestion Status Update API.

4. Update Spot Information

When a spot is updated in the external CMS, call the Spot Update API.

5. Set a Spot to Private

When a spot is temporarily removed in the external CMS (e.g., if recovery from deletion is possible), you can set the spot to private using the Spot Update API. To make the spot public again, also use the Spot Update API.

6. Delete a Spot

When a spot is permanently deleted in the external CMS, call the Spot Deletion API.

Authentication Method

Set the issued API key in the HTTP header as Platinumaps-Api-Key.

spots

Spot information

Get a list of spots

Returns information for all registered spots on the map.

Authorizations:

apiKey

header Parameters

Platinumaps-Map-Slug

string

Example: yourmapslug

Map slug

Responses

Response samples

Content type

application/json

{"spots": [{"spotId": 123,
"title": "string",
"shareType": 1,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Registering spots

Registers a new spot.

Authorizations:

apiKey

header Parameters

Platinumaps-Map-Slug

string

Example: yourmapslug

Map slug

Request Body schema: application/json
required

Information about the spot to be registered

locale required	integer <int32> (LocaleType) Enum: 1 2 3 4 5 6 7 8 9 10 11 Language specification 1:Japanese \| 2:English \| 3:Chinese(Simplified) \| 4:Korean \| 5:Chinese(Traditional) \| 6:French \| 7:Spanish \| 8:Vietnamese \| 9:Indonesian \| 10:Myanmar \| 11:Thai
translationLocales	Array of integers <int32> (LocaleType) >= 0 items [ items <int32 > ] Items Enum: 1 2 3 4 5 6 7 8 9 10 11 Language selection for machine translation (optional)
	Array of objects (Banner) <= 10 characters Spot images
logoImageUrl	string (url) <= 2000 characters URL String
markerImageUrl	string (url) <= 2000 characters URL String
categoryIds	Array of integers <int64> [ items <int64 > ] Categories
pictgramIds	Array of integers <int64> [ items <int64 > ] Pictograms
tags	Array of strings Tags
shareType required	integer <int32> (ShareType) Default: 1 Publication settings 1:Published \| 3:Private \| 9:Deleted
latitude	number Latitude
longitude	number Longitude
effectiveFrom	string <date-time> (datetime) Date/Time string（UTC）
effectiveTo	string <date-time> (datetime) Date/Time string（UTC）
heldFrom	string <date-time> (datetime) Date/Time string（UTC）
heldTo	string <date-time> (datetime) Date/Time string（UTC）
title required	string <= 500 characters Spot/Facility name
titleRuby	string <= 1000 characters Ruby
searchKeyword	string <= 200 characters Search keywords
titleKana	string <= 200 characters Deprecated Search keywords (use `searchKeyword`)
subTitle	string <= 500 characters Subtitle
description	string <= 4000 characters Description
address	string <= 1000 characters Address
phoneNumber	string <= 500 characters Phone number
faxNumber	string <= 30 characters FAX number
webUrl	string (url) <= 2000 characters URL String
businessHour	string <= 2000 characters Business hours (free text)
	object (BusinessHourData) Business hours (Structured data)
holiday	string <= 2000 characters Closed days
parking	string <= 2000 characters Parking
access	string <= 2000 characters Access
fee	string <= 2000 characters Fees
paymentMethod	string <= 2000 characters Payment methods
remarks	string <= 2000 characters Notes
	Array of objects Detailed item list
	object (SnsLinks) Links to various social media sites
	object (FloorOptions) Available for Metamap system only
	Array of objects (MenuRequest) Menu (price list) information.

Responses

Request samples

Payload

Content type

application/json

{"locale": 1,
"translationLocales": [1
],
"banners": [{"url": "string",
"mediaType": 1,
"caption": "string"
}
],
"logoImageUrl": "string",
"markerImageUrl": "string",
"categoryIds": [111,
222,
333
],
"pictgramIds": [444,
555,
666
],
"tags": ["Tempura",
"Sushi"
],
"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",
"title": "string",
"titleRuby": "string",
"searchKeyword": "string",
"titleKana": "string",
"subTitle": "string",
"description": "string",
"address": "string",
"phoneNumber": "string",
"faxNumber": "string",
"webUrl": "string",
"businessHour": "string",
"businessHourData": {"normal": [{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
}
],
"holiday": {"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
}
},
"holiday": "string",
"parking": "string",
"access": "string",
"fee": "string",
"paymentMethod": "string",
"remarks": "string",
"customProperties": [{"customPropertyId": 0,
"value": "string"
}
],
"sns": {"facebook": "string",
"x": "string",
"instagram": "string",
"youtube": "string",
"line": "string",
"weibo": "string",
"threads": "string"
},
"floorOptions": {"floor": "2F",
"floorDescription": "2nd floor food court",
"block": "A123",
"area": "T1"
},
"menus": [{"menuId": 0,
"name": "string",
"columnCount": 1,
"currencyCode": "JPY",
"withTax": true,
"sortOrder": 0,
"shareType": 1,
"items": [{"menuItemId": 0,
"name": "string",
"description": "string",
"priceText": "string",
"imageUrl": "string",
"useFreePriceText": true,
"priceTextCommon": "string",
"sortOrder": 0,
"shareType": 1
}
]
}
]
}

Response samples

Content type

application/json

{"spotId": 0,
"createdAt": "2019-08-24T14:15:22Z"
}

Get spot details

Returns detailed information about the spot.

Authorizations:

apiKey

path Parameters

spotId

required

integer <int64>

Example: 123

Spot ID

query Parameters

locale

integer <int32> (LocaleType)

Enum: 1 2 3 4 5 6 7 8 9 10 11

Example: locale=1

Language specification

header Parameters

Platinumaps-Map-Slug

string

Example: yourmapslug

Map slug

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": [{"url": "string",
"staticImageUrl": "string",
"width": 0,
"height": 0,
"mediaType": 1,
"caption": "string"
}
],
"thumbnailImageUrl": "string",
"logoImageUrl": "string",
"markerImageUrl": "string",
"markerIconWidth": 0,
"markerIconHeight": 0,
"categoryIds": [0
],
"pictgramIds": [0
],
"tags": ["string"
],
"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",
"title": "string",
"titleRuby": "string",
"searchKeyword": "string",
"titleKana": "string",
"subTitle": "string",
"description": "string",
"address": "string",
"phoneNumber": "string",
"faxNumber": "string",
"webUrl": "string",
"businessHour": "string",
"holiday": "string",
"parking": "string",
"access": "string",
"fee": "string",
"paymentMethod": "string",
"remarks": "string",
"customProperties": [{"customPropertyId": 0,
"label": "string",
"value": "string",
"dataType": 1,
"flagType": 3,
"isHidden": true,
"textAlign": 1
}
],
"sns": {"facebook": "string",
"x": "string",
"instagram": "string",
"youtube": "string",
"line": "string",
"weibo": "string",
"threads": "string"
},
"floorOptions": {"floor": "2F",
"floorDescription": "2nd floor food court",
"block": "A123",
"area": "T1"
},
"menus": [{"menuId": 0,
"name": "string",
"columnCount": 0,
"currencyCode": "JPY",
"withTax": true,
"sortOrder": 0,
"shareType": 1,
"items": [{"menuItemId": 0,
"name": "string",
"description": "string",
"priceText": "string",
"imageUrl": "string",
"useFreePriceText": true,
"priceTextCommon": "string",
"sortOrder": 0,
"shareType": 1
}
]
}
]
}

Update spot

Updates the information of the specified spot.

Authorizations:

apiKey

path Parameters

spotId

required

integer <int64>

Example: 123

Spot ID

header Parameters

Platinumaps-Map-Slug

string

Example: yourmapslug

Map slug

Request Body schema: application/json
required

spotId required	integer <int64> Spot ID of the spot to be updated
locale required	integer <int32> (LocaleType) Enum: 1 2 3 4 5 6 7 8 9 10 11 Language specification 1:Japanese \| 2:English \| 3:Chinese(Simplified) \| 4:Korean \| 5:Chinese(Traditional) \| 6:French \| 7:Spanish \| 8:Vietnamese \| 9:Indonesian \| 10:Myanmar \| 11:Thai
translationLocales	Array of integers <int32> (LocaleType) >= 0 items [ items <int32 > ] Items Enum: 1 2 3 4 5 6 7 8 9 10 11 Language selection for machine translation (optional)
	Array of objects (Banner) <= 10 characters Spot image (do not include information on banners to be deleted)
logoImageUrl	string (url) <= 2000 characters URL String
markerImageUrl	string (url) <= 2000 characters URL String
categoryIds	Array of integers <int64> [ items <int64 > ] Categories
pictgramIds	Array of integers <int64> [ items <int64 > ] Pictograms
tags	Array of strings Tags
shareType required	integer <int32> (ShareType) Default: 1 Publication settings 1:Published \| 3:Private \| 9:Deleted
latitude	number Latitude
longitude	number Longitude
effectiveFrom	string <date-time> (datetime) Date/Time string（UTC）
effectiveTo	string <date-time> (datetime) Date/Time string（UTC）
heldFrom	string <date-time> (datetime) Date/Time string（UTC）
heldTo	string <date-time> (datetime) Date/Time string（UTC）
title required	string <= 500 characters Spot/Facility name
titleRuby	string <= 1000 characters Ruby
searchKeyword	string <= 200 characters Search keywords
titleKana	string <= 200 characters Deprecated Search keywords (use `searchKeyword`)
subTitle	string <= 500 characters Subtitle
description	string <= 4000 characters Description
address	string <= 1000 characters Address
phoneNumber	string <= 500 characters Phone number
faxNumber	string <= 30 characters FAX number
webUrl	string (url) <= 2000 characters URL String
businessHour	string <= 2000 characters Business hours (free text)
	object (BusinessHourData) Business hours (Structured data)
holiday	string <= 2000 characters Closed days
parking	string <= 2000 characters Parking
access	string <= 2000 characters Access
fee	string <= 2000 characters Fees
paymentMethod	string <= 2000 characters Payment methods
remarks	string <= 2000 characters Notes
	Array of objects Detailed item list
	object (SnsLinks) Links to various social media sites
	object (FloorOptions) Available for Metamap system only
	Array of objects (MenuRequest) Menu (price list) information. If specified, the existing menu information will be completely overwritten by the contents of this array. To delete all menu groups, specify an empty array `[]`.

Responses

Request samples

Payload

Content type

application/json

{"spotId": 123,
"locale": 1,
"translationLocales": [1
],
"banners": [{"url": "string",
"mediaType": 1,
"caption": "string"
}
],
"logoImageUrl": "string",
"markerImageUrl": "string",
"categoryIds": [111,
222,
333
],
"pictgramIds": [444,
555,
666
],
"tags": ["Curry",
"Sushi"
],
"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",
"title": "string",
"titleRuby": "string",
"searchKeyword": "string",
"titleKana": "string",
"subTitle": "string",
"description": "string",
"address": "string",
"phoneNumber": "string",
"faxNumber": "string",
"webUrl": "string",
"businessHour": "string",
"businessHourData": {"normal": [{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
}
],
"holiday": {"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
}
},
"holiday": "string",
"parking": "string",
"access": "string",
"fee": "string",
"paymentMethod": "string",
"remarks": "string",
"customProperties": [{"customPropertyId": 0,
"value": "string"
}
],
"sns": {"facebook": "string",
"x": "string",
"instagram": "string",
"youtube": "string",
"line": "string",
"weibo": "string",
"threads": "string"
},
"floorOptions": {"floor": "2F",
"floorDescription": "2nd floor food court",
"block": "A123",
"area": "T1"
},
"menus": [{"menuId": 0,
"name": "string",
"columnCount": 1,
"currencyCode": "JPY",
"withTax": true,
"sortOrder": 0,
"shareType": 1,
"items": [{"menuItemId": 0,
"name": "string",
"description": "string",
"priceText": "string",
"imageUrl": "string",
"useFreePriceText": true,
"priceTextCommon": "string",
"sortOrder": 0,
"shareType": 1
}
]
}
]
}

Response samples

Content type

application/json

{"spotId": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

Partially update spot

Updates only the specified fields of the specified spot's information.

Do not include the key names of items that are not to be updated in the request's JSON structure.

Example: Updating only the address

{
  "spotId": 123,
  "locale": 1,
  "address": "3-9 Nishishinjuku, Shinjuku-ku, Tokyo, Frontier Shinjuku Tower"
}

If a field key name exists, the value will be updated even if it is null.

Example: Deleting the description

{
  "spotId": 123,
  "locale": 1,
  "description": null
}

In the PatchSpot model, top-level items are not updated by omitting their key names. However, for nested items, you must specify all values for the updated fields. Any unspecified nested items will be updated to null.

Example: Updating the URL for X (formerly Twitter) and deleting other URLs (such as Facebook)

{
  "spotId": 123,
  "locale": 1,
  "sns": {
    "x": "[https://x.com/BoldrightInc](https://x.com/BoldrightInc)"
  }
}

Authorizations:

apiKey

path Parameters

spotId

required

integer <int64>

Example: 123

Spot ID

header Parameters

Platinumaps-Map-Slug

string

Example: yourmapslug

Map slug

Request Body schema: application/json
required

spotId required	integer <int64> Spot ID to be updated
locale required	integer <int32> (LocaleType) Enum: 1 2 3 4 5 6 7 8 9 10 11 Language specification 1:Japanese \| 2:English \| 3:Chinese(Simplified) \| 4:Korean \| 5:Chinese(Traditional) \| 6:French \| 7:Spanish \| 8:Vietnamese \| 9:Indonesian \| 10:Myanmar \| 11:Thai
translationLocales	Array of integers <int32> (LocaleType) >= 0 items [ items <int32 > ] Items Enum: 1 2 3 4 5 6 7 8 9 10 11 Language selection for machine translation (optional)
	Array of objects (Banner) <= 10 characters Spot images
logoImageUrl	string (url) <= 2000 characters URL String
markerImageUrl	string (url) <= 2000 characters URL String
categoryIds	Array of integers <int64> [ items <int64 > ] Categories
pictgramIds	Array of integers <int64> [ items <int64 > ] Pictograms
tags	Array of strings Tags
shareType	integer <int32> (ShareType) Default: 1 Publication settings 1:Published \| 3:Private \| 9:Deleted
latitude	number Latitude
longitude	number Longitude
effectiveFrom	string <date-time> (datetime) Date/Time string（UTC）
effectiveTo	string <date-time> (datetime) Date/Time string（UTC）
heldFrom	string <date-time> (datetime) Date/Time string（UTC）
heldTo	string <date-time> (datetime) Date/Time string（UTC）
title	string <= 500 characters Spot/Facility name
titleRuby	string <= 1000 characters Ruby
searchKeyword	string <= 200 characters Search keywords
subTitle	string <= 500 characters Subtitle
description	string <= 4000 characters Description
address	string <= 1000 characters Address
phoneNumber	string <= 500 characters Phone number
faxNumber	string <= 30 characters FAX number
webUrl	string (url) <= 2000 characters URL String
businessHour	string <= 2000 characters Business hours (free text)
	object (BusinessHourData) Business hours (Structured data)
holiday	string <= 2000 characters Closed days
parking	string <= 2000 characters Parking
access	string <= 2000 characters Access
fee	string <= 2000 characters Fees
paymentMethod	string <= 2000 characters Payment methods
remarks	string <= 2000 characters Notes
	Array of objects Detailed item list
	object (SnsLinks) Links to various social media sites
	object (FloorOptions) Available for Metamap system only
	Array of objects (PatchMenu) Menu (price list) information. If specified, the existing menu information will be completely overwritten by the contents of this array. To delete all menu groups, specify an empty array `[]`.

Responses

Request samples

Payload

Content type

application/json

{"spotId": 123,
"locale": 1,
"translationLocales": [1
],
"banners": [{"url": "string",
"mediaType": 1,
"caption": "string"
}
],
"logoImageUrl": "string",
"markerImageUrl": "string",
"categoryIds": [111,
222,
333
],
"pictgramIds": [444,
555,
666
],
"tags": ["Curry",
"Sushi"
],
"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",
"title": "string",
"titleRuby": "string",
"searchKeyword": "string",
"subTitle": "string",
"description": "string",
"address": "string",
"phoneNumber": "string",
"faxNumber": "string",
"webUrl": "string",
"businessHour": "string",
"businessHourData": {"normal": [{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
},
{"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
}
],
"holiday": {"isOpen": true,
"hours": [{"open": "stri",
"close": "stri",
"lastOrder": "stri"
}
]
}
},
"holiday": "string",
"parking": "string",
"access": "string",
"fee": "string",
"paymentMethod": "string",
"remarks": "string",
"customProperties": [{"customPropertyId": 0,
"value": "string"
}
],
"sns": {"facebook": "string",
"x": "string",
"instagram": "string",
"youtube": "string",
"line": "string",
"weibo": "string",
"threads": "string"
},
"floorOptions": {"floor": "2F",
"floorDescription": "2nd floor food court",
"block": "A123",
"area": "T1"
},
"menus": [{"menuId": 0,
"name": "string",
"columnCount": 1,
"currencyCode": "JPY",
"withTax": true,
"sortOrder": 0,
"shareType": 1,
"items": [{"menuItemId": 0,
"name": "string",
"description": "string",
"priceText": "string",
"imageUrl": "string",
"useFreePriceText": true,
"priceTextCommon": "string",
"sortOrder": 0,
"shareType": 1
}
]
}
]
}

Response samples

Content type

application/json

{"spotId": 0,
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete spot

Deletes the specified spot.

Authorizations:

apiKey

path Parameters

spotId

required

integer <int64>

Example: 123

Spot ID

header Parameters

Platinumaps-Map-Slug

string

Example: yourmapslug

Map slug

Responses

Response samples

Content type

application/json

{ }

Register spot congestion status

Sets the congestion status or wait time for a spot.

Authorizations:

apiKey

header Parameters

Platinumaps-Map-Slug

string

Example: yourmapslug

Map slug

Request Body schema: application/json
required

Spot congestion status

spotId required	integer <int64> Spot ID to configure
statusType required	integer <int32> Enum: 0 1 Congestion category 0:Congestion information \| 1:Wait time
crowdStatusConfigId	integer <int64> Congestion status ID (required when congestion category is 0)
crowdStatusLevel	integer <int32> Specifies the level for the Congestion Status ID setting (e.g., 3:Crowded).
waitingTimeType	integer <int32> Enum: 0 1 2 Wait time category 0:Minutes \| 1:Within minutes \| 2:Minutes or more (required when congestion category is 1)
waitingTime	integer <int32> Wait time (in minutes) (required when congestion category is 1)

Responses

Request samples

Payload

Content type

application/json

{"spotId": 123,
"statusType": 0,
"crowdStatusConfigId": 44,
"crowdStatusLevel": 3,
"waitingTimeType": null,
"waitingTime": null
}

Response samples

Content type

application/json

{ }

Get spot list differences

Returns information for spots whose update time falls within the specified period.

Authorizations:

apiKey

query Parameters

from required	string <date-time> (datetime) Updated at (From)
to	string <date-time> (datetime) Updated at (To)

header Parameters

Platinumaps-Map-Slug

string

Example: yourmapslug

Map slug

Responses

Response samples

Content type

application/json

{"spots": [{"spotId": 123,
"shareType": 1,
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

CSV/Excel data integration

Upload a CSV or Excel file in multipart/form-data format to perform batch registration, updating, or deletion of spot information. When this API call is complete, only the request is accepted, and the actual registration, update, or deletion process is performed asynchronously. Please check the processing progress and results from "Excel Data Integration" on the Platinumaps admin screen.

Input file format

Please refer to the Excel format that can be downloaded from the "Excel Data Integration" section of the Platinumaps admin screen, as well as the help documentation for the settings on the same page.

For CSV files, please insert a header row with the same column names as the Excel format as the first row. Character encoding: UTF-8 Line breaks: LF

Authorizations:

apiKey

header Parameters

Platinumaps-Map-Slug

string

Example: yourmapslug

Map slug

Request Body schema: multipart/form-data
required

file

required

string <binary>

Excel file to upload

Responses

Response samples

Content type

application/json

{ }

Platinumaps API (1.2.0)

Overview

Data Integration Flow

1. Register a Spot

Spot ID Mapping

2. Register Multilingual Information for a Spot

3. Register Congestion Status for a Spot

4. Update Spot Information

5. Set a Spot to Private

6. Delete a Spot

Authentication Method

spots

Get a list of spots

Authorizations:

header Parameters

Responses

Response samples

Registering spots

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get spot details

Authorizations:

path Parameters

query Parameters

header Parameters

Responses

Response samples

Update spot

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Partially update spot

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete spot

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Register spot congestion status

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get spot list differences

Authorizations:

query Parameters

header Parameters

Responses

Response samples

CSV/Excel data integration

Input file format

Authorizations:

header Parameters

Request Body schema: multipart/form-datarequired

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: multipart/form-data
required