With the REST API connection type you can get data from your sites or the other sources on the internet and display it on your pages.

Note: A REST API is an application program interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data.

Prerequisite


Step 1: Add a ShortPoint Design Element


You can choose and add any ShortPoint Design Element you want. ShortPoint Design Elements can be easily added to your pages using ShortPoint Page Builder.

  • Modern page:

You can start with adding a ShortPoint web part to your page by clicking the plus sign and selecting ShortPoint from the list of the web parts. 


  • Classic page:

1. Choose the Insert tab in the Ribbon.

2. Click the blue Insert button.



Then, select the chosen ShortPoint Design Element from your Page Builder menu. For the purposes of this article we are using ShortPoint Simple Lists.



Step 2: Connect your Design Element to the REST API


Switch to Connect tab and select the REST API connection option.



Enter the REST API URL you would like to get the data from to the REST API URL field, and click Connect.

Note: Service URL link could be any REST Web Service endpoint which responds JSON data.



Wait for the connection to load.



Now the REST API is connected. To complete the connection, we need to map the fields, as shown above.


Please proceed to the next step to do it.

Note: You will see data information in the Data Example field, if you have connected correctly. 

Step 3: Map the Items


Switch to the Items tab.



Map the corresponding properties to display on your page. Click the chain icon and choose the option you would like to map from the drop-down.



In our example we mapped the Title field with the Title, Description field with the Description content from the site and selected lightbox as a linking option.



Note: Check our ShortPoint Connect: Basic Tutorial for more information on how ShortPoint Connect works.

Step 4: Click Insert and save the page

You can click Preview button to check how it will be displayed on your page.



Then, click Insert and save the page.



Note: If you are editing the element not for the first time, instead of Insert you will see the Update button.

Example

Here is a sample web part that uses ShortPoint Connect REST API option:



Related articles: