Mapme API documentation

Updated: July 16, 2024

You can programmatically access, create, modify, and delete map data with the Mapme REST API.

Generate and Manage Your Mapme API Key

Key validity

API keys (or tokens) are unique identifiers that grant access to your Mapme account. Each key is linked to the user who generates the key. The key becomes invalid if the user is removed from the account.

API Key Validity

API keys, also known as tokens, are unique identifiers that grant access to your Mapme account. Each key is securely linked to the user who generates it. Important points to note:

1. User-specific: Keys are tied to individual users.
2. Invalidation: If a user is removed from the account, their associated key becomes invalid.
3. Security: Treat API keys as sensitive information and avoid sharing them.
4. Identification: For easier identification, the API key management interface displays the first 4 digits of each key.

Generating Your API Key

1. In the Mapme editor, navigate to the top-right menu and select Account Info > API Access Token.
2. Click on “Generate API Key”.
3. Important: Copy the displayed key immediately and store it securely. You won’t be able to view it again once you leave this page.

Definitions

Scenes

Scenes include all the map data:

• the map settings
• the map locations
• The map categories and drawings

Sections

Sections contain all the data for each location on the map. The data includes for example the location name, address, and description.

Updating sections

Here are the steps we recommend to update an existing section (map location).

• Retrieve the Current Data: Initiate a GET request to fetch the current state of the resource.
• Modify the Data: Once you receive the response, modify the necessary fields in the JSON payload.
• Update the Data: Send a PATCH request with the modified JSON payload to update the resource.

Note: The response format from the GET request matches the expected format for the PATCH request.

Create sections

Here are useful tips to create a new map location through the API

Input Parameters
Provide either the address or latitude/longitude (lat/long). If only the address is provided, the API will automatically geolocate to determine the corresponding lat/long.

Additional Settings
In the JSON payload, you can define the zoom, pitch, and bearing for the location. If these settings are not specified, the location will adopt default values for zoom, pitch, and bearing.

Draft and published data

The current APIs are fetching data in draft mode. All changes made using the APIs are in draft mode. To commit and publish the changes, use the PUT Scenes API.

Direct link to API documentation