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. Currently, ShortPoint REST API connection type only supports GET requests.

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

TABLE OF CONTENTS

• Prerequisite
• Step 1: Add a ShortPoint Design Element
• Step 2: Connect your Design Element to the REST API
• Step 3: Map the Items
• Step 4: Click Insert and save the page
• Example

Prerequisite

• You have prepared a valid for SharePoint REST API URL link. To know more about REST service in SharePoint, check this article from Microsoft: Get to know the SharePoint REST service.

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 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.

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 take.

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:

• ShortPoint Connect: Basic Tutorial
• Modify the URL Path Function for your REST API connection
• Modify URL Parameters Function for your REST API connection
• ShortPoint RSS Feed Connections stopped working
• How to Make a field clickable when using REST API connection with table
• Connect ShortPoint with external business systems
• How to Connect to a Folder inside a Document Library
• How to Make a Counter Box Show the Total Number of Items in a SharePoint List
• How to Make a Counter Box Show the Number of Items in a SharePoint List (Different Views)
• Connect ShortPoint Elements with Hub Site Documents
• How to Show Both Files and Folders of the Document Library in your ShortPoint Element
• How to Map Document / File Type Icon when Using SharePoint Document Library REST API
• Connection Types: Web Service (XML)