Create External REST API endpoints in Dotnetnuke (DNN)

Overview

The DNN REST API plugin enables smooth integration of external APIs to DNN sites, which enables fetch and update operations on external data through API calls. This plugin enables, to retrieve or update external data during various DNN events or operations, such as user login, user registration etc. This guide will provide you with a step by step process to set up External REST API for DNN sites.

Pre-requisites: Download and Installation

• To configure External APIs for DNN REST API, you will need to install the miniOrange DNN REST API Authentication plugin from DNN store.
• Upload the installation package by going to Settings > Extension > Install Extension.

Configuration Steps

Step by Step guide for DNN External API Authentication.

1. Add module on DNN page

• Open any of the page on your DNN site (Edit mode) and click on Add Module.

• Search for DNN REST API and click on the DNN REST API. Drag and drop the module on the page where you want.

• You have finished with the Installation of the DNN REST API module on your DNN site.

2. Create External APIs

• Navigate to the DNN REST API Settings Tab. Here, you will see the DNN REST API Plugin Dashboard.

• Click on Create API, to initiate external API generation.

• Now Select External API.

• Enter the following details:

1. API Name: Provide a unique name for your API.
2. API Method: Select HTTP request method from the dropdown.
3. External API Endpoint: Configure your external API Endpoint.

• You can configure the Authentication method for the API from the authorization tab and add Headers if required from the Headers tab.
• You can also pass the data in the body in different formats including JSON, x-www-form-urlencoded, xml etc. from the Body tab.
• In the advanced settings section, you have an option to pass the parameters.
• After entering the details, click on Generate API.

• Now, under the External APIs section, you can find your generated API.

3. Test External APIs

• To test the API, click the Test option under the Action dropdown.

• A Test Pop-up will appear. Provide the required details such as headers or body data and then click on Execute button.

• If everything is configured correctly, a success response will be returned by the API confirming that your external api is configured correctly.

This guide will enable you to set up and integrate your external APIs into your DNN application. By utilizing this REST API integration with DNN, you can securely perform fetch, insert, update and delete operations on the external data through API calls from your DNN application.

Additional Resource

• What is REST API Authentication?
• DNN SAML SSO
• DNN OAuth SSO
• DNN Two Factor Authentication (2FA)
• DNN PowerBI Integration