How can we help you today?

Connection Type: REST API

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.


Here is an example of how it may look like on your page: 


REST API example 


TABLE OF CONTENTS


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. 


Add ShortPoint a Modern page

  • Classic page:

1. Choose the Insert tab in the Ribbon.

2. Click the blue Insert button.


Add ShortPoint a Classic page


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


Simple Lists


Step 2: Connect your Design Element to the REST API


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


REST API from Connect tab


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


REST API URL


Wait for the connection to load.


Connected successfully


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. 

Data example

Step 3: Map the Items


Switch to the Items tab.


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.


Items mapping - chain icon


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.


Items mapping example


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.


Preview


Then, click Insert and save the page.


Insert/Update


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:


REST API example


Related articles:

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

World's best intranet sites are designed using ShortPoint

Get started today! Learn more
See all 19 topics

Start a trial

Ignite your vision. Install ShortPoint directly on your site, or play in sandbox mode. No credit card required.

Get started today

World’s best intranet sites are designed using ShortPoint

Thousands of companies using ShortPoint everyday to design, brand and build award winning intranet sites.

Get started Learn more