Crear puntos finales de API REST personalizados en Dotnetnuke (DNN)
Resumen
El complemento DNN REST API permite crear puntos de conexión de API personalizados dentro de la plataforma DNN, lo que permite que sistemas externos interactúen con las funcionalidades de DNN. Puede configurar fácilmente sus puntos de conexión de API personalizados para cumplir con requisitos específicos, utilizando todos los métodos HTTP. Esta guía del usuario ofrece documentación completa para ayudarle a configurar y probar API personalizadas.
Requisitos previos: descarga e instalación
- Para configurar API personalizadas 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 personalizada 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 personalizadas
- Navegue a la pestaña Pestaña de configuración de API REST de DNN. Aquí verás la Panel de control del complemento de autenticación de API REST de DNN.
- Haga clic en Crear API, para iniciar la generación de API personalizada.
- Seleccione el tipo de API como API personalizada.
- 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.
- Nombre de la tabla: Especifique la tabla a la que desea acceder.
- Columna de respuesta: Seleccione las columnas en las que desea realizar operaciones.
- Configurar autenticación (opcional): En la pestaña Configuración avanzada, puede encontrar una opción para seleccionar los métodos de autenticación para la API que incluye clave API, autenticación básica, JWT, etc. y asignar la aplicación de autenticación creada para el método respectivo.
- Aplicar filtros (opcional): Puede aplicar condiciones en las columnas que le permitan acceder a registros específicos en función de los filtros aplicados.
Para configurarlo, puede seleccionar la columna del menú desplegable Columna Condición y luego elegir la Condición y el Parámetro URL en el que desea aplicar la condición.
- Haga clic en Generar API.
- Ahora bajo el API personalizadas Sección, puede localizar su API creada.
3. Pruebe las API generadas
- Para probar la API, haga clic en el Prueba en la sección de Acción: desplegable.
- Aparecerá una ventana emergente de prueba con el punto final de la API y el método HTTP configurado. Puede encontrar la opción para pasar los parámetros en los encabezados o los datos en el cuerpo si es necesario. A continuación, haga clic en Ejecutar.
- Si todo está configurado correctamente, verás una respuesta exitosa, confirmando que tu API está funcionando como se esperaba.
- Puede consultar los formatos de solicitud y respuesta de muestra para su solicitud de API desde la ventana emergente de prueba.
Esta guía le permitirá configurar y crear API REST personalizadas para su sitio DNN. Mediante el plugin DNN REST API, podrá configurar, probar y administrar las API REST de DNN de forma segura.
