Crear puntos finales de API REST externos en Dotnetnuke (DNN)
Resumen
El complemento DNN REST API facilita la integración de API externas en sitios DNN, lo que permite obtener y actualizar datos externos mediante llamadas a la API. Este complemento permite recuperar o actualizar datos externos durante diversas operaciones o eventos DNN, como el inicio de sesión y el registro de usuarios, etc. Esta guía le mostrará paso a paso el proceso para configurar una API REST externa para sitios DNN.
Requisitos previos: descarga e instalación
- Para configurar las API externas para la API REST de DNN, deberá instalar el Complemento de autenticación de API REST DNN miniOrange de la tienda DNN.
- Sube el paquete de instalación yendo a Configuración > Extensión > Instalar extensión.
Pasos de configuración
Guía paso a paso para la autenticación de API externa de DNN.
1. Agregar módulo en la página DNN
- Abra cualquiera de las páginas de su sitio DNN (modo de edición) y haga clic en Agregar Módulo.
- Busque API REST DNN Haz clic en la API REST de DNN. Arrastra y suelta el módulo en la página que desees.
- Ha finalizado la instalación del módulo API REST de DNN en su sitio DNN.
2. Crear API externas
- Navegue a la pestaña Configuración de la API REST de DNN Pestaña. Aquí verás la Panel de control del complemento API REST de DNN.
- Haga clic en Crear API, para iniciar la generación de API externa.
- Ahora seleccione API externa.
- Ingrese los siguientes detalles:
- Nombre de la API: Proporcione un nombre único para su API.
- Método API: Seleccionar Método de solicitud HTTP desde el desplegable.
- Punto final de API externo: Configure su punto final de API externo.
- Puede configurar el método de autenticación para la API desde la pestaña de autorización y agregar encabezados si es necesario desde la pestaña Encabezados.
- También puede pasar los datos en el cuerpo en diferentes formatos, incluidos JSON, x-www-form-urlencoded, xml, etc. desde la pestaña Cuerpo.
- En la sección de configuración avanzada, tienes una opción para pasar los parámetros.
- Después de ingresar los detalles, haga clic en Generar API.
- Ahora, en la sección API externas, puedes encontrar la API generada.
3. Pruebe las API externas
- Para probar la API, haga clic en el Prueba en la sección de Acción: desplegable.
- Aparecerá una ventana emergente de prueba. Ingrese los detalles requeridos, como encabezados o datos del cuerpo, y luego haga clic en Implementación .
- Si todo está configurado correctamente, la API devolverá una respuesta de éxito confirmando que su API externa está configurada correctamente.
Esta guía le permitirá configurar e integrar sus API externas en su aplicación DNN. Al utilizar esta integración de API REST con DNN, podrá realizar operaciones de búsqueda, inserción, actualización y eliminación de datos externos de forma segura mediante llamadas a la API desde su aplicación DNN.
