JSON

The Enplug integration hub allows users to link their JSON account to Enplug to display data.

Requirements

To use the JSON integration, you’ll need:

•  A Professional or Enterprise Enplug account 
• JSON File (Required): ProductID is a required field
• The settings listed below must be set

Note: The Edit Integration menu will be launched during the Adding a JSON Integration process documented below.

• HTTP Headers (Optional): Headers can be used to provide context and instructions.
• API Refresh Frequency (Required): This determines how often data will be refreshed. If an immediate data refresh is needed, the refresh icon in the Data tab can be used to refresh in realtime.
• Create custom integration: Used to manually set up an integration without pre-configured mapping.
• Create product built-in integration: Used to pre-configure mapping for an integration.
• URL (Required): This URL must be a direct link to the JSON file (EX: https://api.npoint.io/ce2aed94c73c7708e5c7). These will appear differently depending on where the JSON is hosted.
• Query Parameters (Optional): Enter to add key-value pairs to the end of a URL's query string. This is used to pass additional data to the web server.

Adding a JSON Integration

To add a JSON integration:

1. Login to Enplug.
2. Click the gear icon in the bottom-left corner of the screen to launch the Settings menu.
3. Click Integrations.
4. Click New Integration.
5. From the available options, select JSON.
   • Keep the Active toggle on to keep an integration active. 
   • Enable the Auto-Update toggle to download new data when available.
6. After choosing an integration, fill in the requested fields. 
   • These will be based on the program you choose. See above for required fields.
7. Click Test Connection.
   • If the test fails, confirm the information/credentials you’ve entered are correct.
   • If the test is successful, you’ll see a message reading Integration created successfully.
8. Click Create.
9. If location data is available for your POS, Refresh the page to choose locations for display.
10. After refreshing, click Edit.
11. Select the locations where you’d like data displayed.
    • These selections can be changed at any time.
12. Click Save and Close.

Accessing JSON Data in the Menu Board App

To access JSON data from the Menu Board app:

1. Log into Enplug.
2. Select the Menu Board application from the Apps dropdown in the Enplug dashboard.

3. Click Product Library in the top right corner.
4. From here, you’ll see two tabs: Products and Integrations.
5. Click Integrations.
6. Product data will automatically import to the Integrations tab in 15-minute intervals.

You can also import data immediately using a forced import of integration data.

To do so:

1. From the Product Library page, click Import Products.
2. To the right of the search bar, click Upload and select the data you’d like to import.
3. If successful, the Status of the integration data will read Done.
   • If there is an error, click the download icon under Error Logs to review.

Adjusting the JSON Data View

To adjust the JSON data view:

1. Log into Enplug.
2. Select the Menu Board application from the Apps dropdown in the Enplug dashboard.
3. Click Product Library in the top right corner.
4. From here, you’ll see two tabs: Products and Integrations.
5. Click Integrations.
   • Non-applicable Product Library columns will appear blank.
6. Click the eye icon, then select the data you’d like to view and add to your menu board.

7. Click Save Changes.

Note: You can rearrange the data column order by clicking-and-dragging a column header to a desired location, then clicking Save Changes.

Adding JSON Data to a New Menu Canvas

To add integration data to a new menu canvas:

1. Log into Enplug.
2. Select the Menu Board application from the Apps dropdown in the Enplug dashboard.
3. To the right of the search bar, click Add New Menu.
4. In the top menu, click the book icon that displays Add products.
   • This will launch a Product Library pop-up window.

5. Click the dropdown and select JSON.
   • Data from the integration will auto-populate for selection.
6. To add a single item, check the box next to the desired data then click Add as a single product. To add multiple items, check the boxes next to the desired data then click Add as a list of products.
7. Placeholder boxes will now appear on the new menu canvas.

From here, you can click the pencil icon to edit the layout, select the properties you’d like displayed and format accordingly.

Notes: 

• Any changes made to an item from a list will apply to all of the items in that list.
• Data refreshes every 15 minutes.

Additional Formatting a New Menu Canvas

If you have more items than will fit in the allotted space, you can enable data scrolling or pagination.

To do so:

1. Log into Enplug.
2. Follow the process of Adding Integration Data to a New Menu Canvas (see above).
3. Select the Product List you’d like to apply scrolling to.
4. In the right-side menu, click the Properties dropdown.
5. Under Scroll Type, check the Scroll box.

Note: It isn’t recommended to exceed 50 items in a scrolling list.

Alternatively, if you have more items than will fit in the allotted space, you can enable data pagination. This will display data in pages.

To do so:

1. Log into Enplug.
2. Follow the process of Adding Integration Data to a New Menu Canvas (see above).
3. Select the Product List you’d like to apply scrolling to.
4. In the right-side menu, click the Properties dropdown.
5. Under Scroll Type, check the Pagination box.
6. You can then adjust the speed and delay of scroll/display time.

Note: It is not recommended to exceed more than three pages of items.

Additional Resources

• Point-of-Sale Integrations: Overview
• Point-of-Sale Integrations: Categories
• Point-of-Sale Integrations: Accessing & Adding Data
• Point-of-Sale Integrations: Adding Dietary Icons & Calories (Cal) Suffix
• Point-of-Sale Integrations: Common Terms & Troubleshooting

For questions or concerns, please reach out to our Support Team at support@spectrio.com.