Создание внешних REST API-интерфейсов в Dotnetnuke (DNN)
Обзор
Плагин DNN REST API обеспечивает плавную интеграцию внешних API с сайтами DNN, позволяя получать и обновлять внешние данные посредством вызовов API. Этот плагин позволяет получать или обновлять внешние данные во время различных событий или операций DNN, таких как вход пользователя в систему, регистрация пользователя и т. д. Это руководство предоставит вам пошаговый процесс настройки внешнего REST API для сайтов DNN.
Предварительные условия: Загрузка и установка.
- Для настройки внешних API для REST API DNN вам потребуется установить... плагин аутентификации miniOrange DNN REST API из магазина DNN.
- Загрузите установочный пакет, перейдя по ссылке: Настройки > Расширения > Установить расширение.
Шаги настройки
Пошаговое руководство по аутентификации через внешний API DNN.
1. Добавьте модуль на страницу DNN.
- Откройте любую страницу на вашем сайте DNN (в режиме редактирования) и нажмите на Добавить модуль.
- Найдите DNN REST API и нажмите на DNN REST API. Перетащите модуль на страницу в нужное место.
- Установка модуля DNN REST API на вашем сайте DNN завершена.
2. Создание внешних API
- Перейдите в Настройки REST API DNN Вкладка. Здесь вы увидите Панель управления плагина DNN REST API.
- Нажмите на Создать API, для инициирования генерации внешнего API.
- Теперь выберите Внешний API.
- Введите следующие данные:
- Имя API: Укажите уникальное имя для вашего API.
- Метод API: Выбрать Метод HTTP-запроса из выпадающего списка.
- Внешняя конечная точка API: Настройте свою внешнюю конечную точку API.
- На вкладке «Авторизация» можно настроить метод аутентификации для API, а на вкладке «Заголовки» при необходимости добавить заголовки.
- Также вы можете передавать данные в теле запроса в различных форматах, включая JSON, x-www-form-urlencoded, xml и т. д., используя вкладку «Тело запроса».
- В разделе расширенных настроек у вас есть возможность передать параметры.
- После ввода данных нажмите на Сгенерировать API.
- Теперь в разделе «Внешние API» вы можете найти сгенерированный вами API.
3. Тестирование внешних API
- Чтобы протестировать API, нажмите на кнопку. Тест вариант под Экшн падать.
- Появится всплывающее окно с тестовым сообщением. Укажите необходимые данные, такие как заголовки или содержимое сообщения, а затем нажмите кнопку. Выполнить .
- Если все настроено правильно, API вернет успешный ответ, подтверждающий корректную настройку вашего внешнего API.
Это руководство поможет вам настроить и интегрировать внешние API в ваше приложение DNN. Используя эту интеграцию REST API с DNN, вы сможете безопасно выполнять операции получения, вставки, обновления и удаления внешних данных посредством вызовов API из вашего приложения DNN.
