Summary

This technical document provides step-by-step instructions on how to set up a JSON API Source containing Points of Interest (POIs) data and import the POIs into MazeMap using the external JSON POI import feature. By following this guide, you'll be able to efficiently manage and import your POI data into MazeMap, enhancing the user experience and improving data organisation.

For a deeper understanding of advanced JSON configurations, data structure, and import settings, refer to the Advanced JSON Import Configuration Guide. This document provides detailed explanations and examples to help you configure and optimize your POI imports.

Skill Level: Advanced MazeMap

Prerequisites

Before you begin, ensure you have the following in place:

1. Access to JSON API Source: Need to be able to pull the data

2. API API response structure: The response from the JS API Call that gets matched to fields in MazeMap.

3. Basic Coding Knowledge: While the guide will provide the necessary configuration, a basic understanding of JSON will be helpful for users to grasp the concepts.

Additional Considerations

Before proceeding with the setup, consider the following points:

1. Data Privacy: Ensure that the JSON API document containing POI data is accessible only to authorised users, as the API is exposed to the web.

2. JSON Format: An API call returns data in JSON format, and MazeMap requires specific field mappings. Users may need to adjust the script or MazeMap settings if the data fields need customisation.

Steps

1) Test the API Connection via online validator.

Follow these steps to test the API connection using Postman Web (which could be another validator).

1. Go to the Postman website (https://www.postman.com/) and log in to your account.

2. Click “My Workspace”.

3. Click on the "+" button in the top-left corner next to “Overview”.

Open

Postman Web

2) Setup the API Call

1. Select “Post” as the method

2. enter the URL of the API including the sheet name from above.

3. Click on the "Send" button to send the API request.

Open

Check the API response

4. After sending the request, you'll see the response from the API.
   If everything is set up correctly, you should receive a JSON response containing the structure and data from your API Call.

3) Setup and configure JSON POI Import

1. Access MazeMap Admin tool https://admin.mazemap.com/ and log in with your MazeMap account.

2. Select the campus you would like to set the import up on.

3. In the Map Editor, click Points of Interest menu followed by POI Import.

4. Click the green button shown below to add a new configuration.

5. Select the POI import configuration and configuration of the POI’s you are importing and give it a name and then click save.
   
   

6. In the configuration editor that has opened, add the JSON config that matches the type of POI import you are undertaking.

   For a full explanation of JSON configuration settings and detailed examples, refer to the Advanced JSON Import Configuration Guide .

   This guide provides:

   • A breakdown of how data is mapped and processed.

   • Detailed explanations of each configuration setting.

   • Example JSON configurations for different POI import types.
     
     

7. Click “save” in the bottom right of the window.

8. Click “Validate Source” to validate the import and see the number of POIS. The total number imported POIs is listed and shown.

Conclusion

By following this technical documentation, you have successfully set up and imported Points of Interest (POIs) data from a JSON API source. This integration enhances the user experience and provides an efficient way to manage POI data within MazeMap.

Replicate these instructions for different POI import types.

For any troubleshooting or further assistance, please refer to the MazeMap support resources or contact our technical support team.