Guía de configuración de extensiones de API personalizadas de Joomla

Resumen

El Extensión de API personalizada para Joomla Te permite crear API personalizadas para ampliar las capacidades del CMS (Sistema de Gestión de Contenidos) de Joomla. Al usar estas API, puedes... Exponer características o datos particulares de su sitio web Joomla, lo que permite que programas o servicios externos se comuniquen con su sitio web Joomla. Gracias a los puntos de conexión personalizados que ha desarrollado, este plugin ofrece un método sencillo para trabajar con la base de datos de Joomla, lo que le permite realizar fácilmente... CRUD (Crear, Leer, Actualizar y Eliminar) operaciones.

Descargar Plugin Planes de Precios Prueba Gratuita

Paso 1: Instalación de la extensión API personalizada

• Descargue el archivo zip para el Extensión API personalizada de miniOrange para Joomla desde el enlace de arriba.
• Inicie sesión en su sitio Joomla Administradora consola.
• Desde el menú de alternancia de la izquierda, haga clic en Sistema, luego bajo Instale sección haga clic en Prórrogas de tiempo para presentar declaraciones de impuestos.

• Aquí haga clic en Buscar archivo Botón para localizar e instalar el archivo de extensión descargado anteriormente.

• Una vez que la instalación del complemento sea exitosa. Ahora haga clic en Comience a usar el complemento API personalizado de Joomla.

Paso 2: Crear API personalizadas

• PUBLICAR [DE PRIMERA CALIDAD]
• PUT [DE PRIMERA CALIDAD]
• BORRAR [DE PRIMERA CALIDAD]

¿Por qué utilizar la API GET?

• Si desea recuperar datos o información de su sitio Joomla, puede crear una API GET. Puede agregar múltiples filtros y condiciones a la API GET con nuestro plugin.
• Al realizar una solicitud GET a una API, puede proporcionar parámetros o cadenas de consulta en la URL para especificar los datos que desea recuperar de su sitio Joomla. El plugin Joomla Custom API procesa la solicitud y devuelve los datos solicitados en la respuesta.

Pasos de configuración para crear una API GET personalizada

• Primero navegue hasta el Crear API personalizada .
• Aquí verás una lista para usar. API DEMO que obtiene datos del #__categorías tabla usando una simple solicitud GET. Haga clic Prueba para ver la respuesta en directo al instante.

• Ahora haga clic en Crear API personalizada .

Configurar los detalles de la API

• Escriba el Nombre de API y seleccione el Método GET del menú desplegable.
• Usando parámetros
• Seleccione el tipo de API: Por parámetros.
• Ahora seleccione el nombre de la tabla en la que desea realizar la acción de recuperación de datos.
• Ahora se mostrarán varias opciones para seleccionar columnas y filtros para esta API. Especifique las columnas de la tabla de la que desea obtener datos del sitio Joomla. Puede seleccionar varias columnas aquí.
• [DE PRIMERA CALIDAD] Seleccione las condiciones y filtros adecuados según sus necesidades, o bien, puede optar por no aplicar ninguna condición. Haga clic en el botón + si desea agregar varias condiciones WHERE para filtrar los datos. También puede eliminar la condición o el filtro haciendo clic en el botón -.
• [DE PRIMERA CALIDAD] Active la sección Habilitar autenticación Opción si desea habilitar la autenticación en el punto final de la API. (Consulte el Paso 3 para aprender cómo configurar la autenticación API).
• Después de configurar la API, haga clic en Guardar botón por último para crear su punto final personalizado/API REST.

• Uso de la API de SQL personalizada [DE PRIMERA CALIDAD]
• Seleccione el tipo de API: API SQL personalizada.
• Escriba la consulta SQL personalizada que desea ejecutar en la llamada a la API correcta. Por ejemplo:

SELECT * FROM #__users WHERE id='{{id_param}}' AND email='{{email_param}}'; tener _ es obligatorio en el nombre del parámetro.



• Haga clic en el elemento Guardar Botón para crear la API personalizada.

¿Por qué utilizar la API POST?

• Si desea enviar datos a su sitio Joomla para crear recursos en el sitio, puede utilizar la API POST.
• Al realizar una solicitud POST a una API, se envían datos en el cuerpo de la solicitud, generalmente en formato JSON o codificado en formulario. El plugin de API personalizada de Joomla procesa los datos y realiza las acciones necesarias según la información proporcionada en la solicitud.

Pasos de configuración para crear una API POST personalizada

• Primero navegue hasta el Crear API/SQL personalizada .
• Haga clic en el elemento Haga clic aquí Botón para crear una nueva API.

• Ingrese una Nombre de API y seleccione el método API POST en el menú desplegable. Luego, haga clic en el botón Crear API .

Configurar los detalles de la API

• Usando parámetros
• Seleccione el tipo de API: Por parámetros.
• Ahora seleccione el nombre de la tabla en la que desea realizar la acción de creación de datos.
• Ahora se mostrarán varias opciones para seleccionar columnas. Especifique las columnas de la tabla de la que desea obtener datos del sitio Joomla. Puede seleccionar varias columnas aquí.
• Seleccione el elemento Formato de datos corporales en el que desea enviar los datos al encabezado desde el desplegable.
• Active la sección Habilitar autenticación Opción si desea habilitar la autenticación en el punto final de la API. (Consulte el Paso 3 para aprender cómo configurar la autenticación API).
• Después de configurar la API, haga clic en Guardar botón por último para crear su punto final personalizado/API REST.

• Uso de la API de SQL personalizada
• Seleccione el tipo de API: API SQL personalizada.
• Puede hacer que todos los parámetros sean obligatorios marcando la casilla. Esta función requiere que todos los parámetros del cliente se transmitan en una llamada API.
• Escriba la consulta SQL personalizada que desea ejecutar en la llamada a la API correcta. Por ejemplo:

INSERTAR EN #__users (id, nombre, nombre de usuario, correo electrónico, fecha de registro, parámetros) VALORES '{{id}}','{{nombre}}','{{nombre de usuario}}','{{correo electrónico}}','{{fecha de registro}}','{{parámetros}}';



• Haga clic en el elemento Guardar Botón para crear la API personalizada.

¿Por qué utilizar la API PUT?

• Si desea actualizar o reemplazar un recurso existente en su sitio Joomla, puede crear una API PUT.
• Al realizar una solicitud PUT a una API, se envían datos en parámetros, cadenas de consulta o en el cuerpo de la solicitud para reemplazar la representación completa del recurso identificado por la URL de la solicitud. El plugin de API personalizada de Joomla procesa los datos y actualiza el recurso según corresponda.

Pasos de configuración para crear una API PUT personalizada

• Primero navegue hasta el Crear API/SQL personalizada .
• Haga clic en el elemento Haga clic aquí Botón para crear una nueva API.

• Ingrese una Nombre de API y seleccione el método PUT API del menú desplegable. Luego, haga clic en el Crear API .

Configurar los detalles de la API

• Usando parámetros
• Seleccione el tipo de API: Por parámetros.
• Ahora seleccione el nombre de la tabla en la que desea ingresar nuevos datos.
• Luego seleccione las columnas que desea actualizar mediante la llamada API.
• Seleccione las condiciones adecuadas según sus necesidades o no las aplique. Haga clic en el botón + si desea agregar varias condiciones WHERE para filtrar los datos. También puede eliminar la condición haciendo clic en el botón -.
• Tiene la flexibilidad de pasar los datos como parámetros de consulta o dentro del cuerpo de la solicitud.
• Asegúrese de pasar los datos utilizando la clave de formato = Nombre del parámetro (mencionado en la tabla Formato de solicitud y condiciones aplicadas) y valor = según los requisitos específicos.
• Para actualizar la entrada de usuario del ejemplo anterior, debe seguir lo siguiente:
• Introduzca la URL: '{joomla_base_url}/api/index.php/v1/mini/custom_put'.
• Luego seleccione el método HTTP PUT.
• Pase datos para nombre, nombre de usuario, param_1, param_2 en el cuerpo de la solicitud (también puede pasarlos en formato de consulta).
• Recibirá 1 en la respuesta si los datos se actualizaron correctamente en la tabla.

• Uso de la API de SQL personalizada
• Seleccione el tipo de API: API SQL personalizada.
• Escriba la consulta SQL personalizada que desea ejecutar en la llamada a la API correcta. Por ejemplo:

ACTUALIZAR #__usuarios establecen nombre de usuario ='{{nombre de usuario}}' donde id ='{{id}}';



• Haga clic en el elemento Guardar Botón para crear la API personalizada.

¿Por qué usar la API DELETE?

• Si desea eliminar un recurso específico en su sitio Joomla, puede crear una API DE ELIMINACIÓN.
• Al realizar una solicitud DELETE a una API, puede proporcionar parámetros o cadenas de consulta en la URL o en el cuerpo de la solicitud para especificar los datos que desea eliminar de su sitio Joomla. El plugin Joomla Custom API procesa los datos y actualiza el recurso según corresponda.

Pasos de configuración para crear una API DELETE personalizada

• Primero navegue hasta el Crear API/SQL personalizada .
• Haga clic en el elemento Haga clic aquí Botón para crear una nueva API.

• Ingrese una Nombre de API y seleccione el método DELETE API del menú desplegable. Luego, haga clic en el Crear API .

Configurar los detalles de la API

• Usando parámetros
• Seleccione el tipo de API: Por parámetros.
• Ahora seleccione el nombre de la tabla en la que desea realizar la acción de eliminación de datos.
• Seleccione las condiciones adecuadas según sus necesidades o no las aplique. Haga clic en el botón + si desea agregar varias condiciones WHERE para filtrar los datos. También puede eliminar la condición haciendo clic en el botón -.
• Active la sección Habilitar autenticación Opción si desea habilitar la autenticación en el punto final de la API. (Consulte el Paso 3 para aprender cómo configurar la autenticación API).
• Después de configurar la API, haga clic en Guardar botón por último para crear su punto final personalizado/API REST.

• Uso de la API de SQL personalizada
• Seleccione el tipo de API: API SQL personalizada.
• Escriba la consulta SQL personalizada que desea ejecutar en la llamada a la API correcta. Por ejemplo:

ELIMINAR DE #__usuarios DONDE id='{{id}}';



• Haga clic en el elemento Guardar Botón para crear la API personalizada.

Paso 3: Configurar la autenticación de API [DE PRIMERA CALIDAD]

• Token de portador
• Autenticación JWT
• Autenticación básica
• API Key

Autenticación de token de portador:

Una autenticación simple basada en token donde los clientes envían un token de portador en el encabezado de autorización.

• Primero active el Habilitar autenticación botón en el Configurar detalles de la API .
• En la sección Configurar autenticación menú, seleccione Token de portador desde el menú desplegable.
• Haga clic en el elemento Generar ficha Botón para crear automáticamente un token aleatorio seguro. Por ejemplo: 7c4a8d09ca3762af61e59520943dc26494f8941b
• Haga clic en "Guardar configuración" para aplicar la configuración del token de portador. El token se almacenará de forma segura en la base de datos.

Uso de API:

• Incluir el token en las solicitudes API:

Header: Authorization: Bearer 7c4a8d09ca3762af61e59520943dc26494f8941b



• Pruebe el token portador utilizando los siguientes comandos cURL:

```golpecito
curl -X GET "https://yoursite.com/api/endpoint" \
-H "Autorización: Portador your_token_here" \
-H "Tipo de contenido: aplicación/json"

Pruebe la autenticación usando Postman:

• Cartero abierto.
• Establezca el método de solicitud y la URL.
• Ahora, vaya a la pestaña Autorización.
• Seleccione el tipo "Token al portador".
• Luego, ingresa tu token en el campo Token.

Autenticación básica (autenticación de usuario de Joomla):

Utiliza credenciales de usuario Joomla existentes (nombre de usuario/contraseña) codificadas en Base64 y enviadas a través del encabezado de Autorización.

• Primero active el Habilitar autenticación botón en el Configurar detalles de la API .
• En la sección Configurar autenticación menú, seleccione Autenticación básica desde el menú desplegable.
• No se requiere ninguna configuración adicional, pero los usuarios deben existir en la base de datos de usuarios de Joomla.
• Por último, haga clic en el Guardar configuración .

Uso de API:

• Incluir nombre de usuario y contraseña de Joomla en las solicitudes de API:

Encabezado: Autorización: Base64 básica (nombre de usuario: contraseña)



• Pruebe la autenticación básica utilizando los siguientes comandos cURL:

```bash curl -X GET "https://yoursite.com/api/endpoint" \
-H "Autorización: Básica $(echo -n 'usuario:contraseña' | base64)" \
-H "Tipo de contenido: aplicación/json"

Pruebe la autenticación usando Postman:

• Cartero abierto.
• Establezca el método de solicitud y la URL.
• Ahora, vaya a la pestaña Autorización.
• Seleccione el tipo "Autenticación básica".
• Introduzca el nombre de usuario y la contraseña de Joomla.

Autenticación de clave API (autenticación de usuario de Joomla):

Autenticación basada en encabezado mediante claves API. Admite claves universales (una sola para todos los usuarios) y claves basadas en el usuario (claves individuales por usuario).

• Primero active el Habilitar autenticación botón en el Configurar detalles de la API .
• En la sección Configurar autenticación menú, seleccione API Key desde el menú desplegable.
• Ahora elige el Tipo de clave API.
• Para la clave API universal:
• Seleccionar Clave API universal boton de radio.
• Haga clic en el botón Generar una clave API universal .
• Se generará una única clave API para todos los accesos a la API. Por ejemplo: uk_7c4a8d09ca3762af61e59520943dc26494f8941b
• Para la clave API basada en el usuario:
• Seleccionar Clave API basada en el usuario boton de radio.
• Generar claves para todos los usuarios existentes de Joomla: Haga clic en Generar claves API para todos los usuariosSe crearán claves para todos los usuarios activos de Joomla.
• Generar clave para usuario específico: Introduce tu nombre de usuario en el campo "Nombre de usuario". Haz clic en Generar clave API para el usuario.
• Haga clic en Guardar configuración para aplicar la configuración de la clave API.

Uso de API:

• Incluir la clave API en las solicitudes:

Encabezado: X-API-KEY:



• Pruebe la clave API utilizando los siguientes comandos cURL:

```golpecito
curl -X GET "https://yoursite.com/api/endpoint" \
-H "X-API-KEY: tu_clave_api_aquí" \
-H "Tipo de contenido: aplicación/json"

Pruebe la autenticación usando Postman:

• Cartero abierto.
• Establezca el método de solicitud y la URL.
• Ahora, vaya a la pestaña Encabezados.
• Agregar encabezado: Clave = "X-API-KEY", Valor = "your_api_key".

Autenticación JWT:

La autenticación JWT permite autenticar el acceso a la API REST personalizada y al punto final de la API predeterminada de Joomla mediante un token JWT válido (JSON Web Token). El plugin proporciona un punto final para generar un JWT de portador utilizando las credenciales de inicio de sesión válidas de Joomla del usuario. El token generado puede usarse para autenticar los puntos finales de la API REST personalizada y de Joomla.

• Primero active el Habilitar autenticación botón en el Configurar detalles de la API .
• En la sección Configurar autenticación menú, seleccione Portador de JWT desde el menú desplegable.
• Ahora elige el Tipo de clave API.
• Seleccione el elemento Algoritmo de firma en el menú desplegable.
• Para HS256, introducir el Llave secreta.
• Para RS256, sube el Claves públicas y privadas.
• Introduzca el tiempo de caducidad (por ejemplo, 3600 para 1 hora).
• Haga clic en el elemento Guardar .

Para obtener el token JWT, siga los siguientes pasos:

• Para obtener el JWT, debemos enviar una consulta POST que contenga las credenciales de Joomla del usuario. El nombre de usuario y la contraseña deben enviarse en formato base64. Para su comodidad, consulte el formato de la solicitud a continuación.

Solicitud: POST {joomla_base_url}/api/index.php/v1/mini/id_token
Encabezamiento:
Autorización: Base64 codificada básica
Aceptar: aplicación / json
Formato de solicitud de curl de muestra
--ubicación --solicitud POST "/api/index.php/v1/mini/id_token' \"
--header 'Aceptar: aplicación/json'\
--header 'Tipo de contenido: aplicación/json' \
--header 'Autorización: Base64 codificada básica' \'

Paso 4: Autenticación para API REST [DE PRIMERA CALIDAD]

Configure la autenticación para las API principales de Joomla y las API alojadas en su sitio Joomla que se aplicarán automáticamente cuando se llamen a estas API.

• Vaya a la Autenticación de API REST .
• Escriba el Nombre de API y Punto final de la API en los campos dados.
• Luego selecciona el Método HTTP en el menú desplegable.
• Luego active el Habilitar autenticación y seleccione el método de autenticación que prefiera. Consulte la Paso 3 Sección de la guía para ver cómo configurar los diferentes métodos de autenticación.

Paso 5: Configurar API externas [DE PRIMERA CALIDAD]

• Vaya a la API externas .
• Introduzca el nombre de la API.
• Luego selecciona el Método API desde el desplegable.
• Escriba el API externa en el campo dado.
• Puede pasar los parámetros de consulta necesarios para esta API configurada. Para que los datos se envíen en el formato de parámetros de consulta.
• Hay 2 campos de texto: el primero es para ingresar la clave y el segundo es para ingresar el valor.
• Por ejemplo→ Si tiene que pasar el siguiente parámetro de consulta 'username→testuser', entonces debe colocar 'username' en la clave y 'testuser' en el campo valuE.
• Puede agregar varios parámetros utilizando el botón +.
• En los encabezados, hay dos cuadros de texto: el izquierdo para el nombre del encabezado y el derecho para el valor que se debe pasar. Por ejemplo: si el encabezado tiene el formato Autorización:Portador, se añadirá "Autorización" en el primer cuadro de texto y "Portador" en el cuadro de texto derecho, como se muestra en el diagrama a continuación.
• Si el proveedor de la API espera que los datos se envíen en el cuerpo de la solicitud de los puntos finales de la API, puede completar la información requerida. Hay dos formatos disponibles para enviar los datos: x-www-form-urlencoded y JSON.
• Para que los datos se envíen en los parámetros del cuerpo en formato x-www-form-urlencoded.
• Hay 2 campos de texto: el primero es para ingresar la clave y el segundo es para ingresar el valor.
• Por ejemplo→ Si tiene que pasar el siguiente parámetro de cuerpo 'username→testuser', entonces debe colocar 'username' en la clave y 'testuser' en el campo de valor.
• Para los pares de valores clave múltiples que deben pasarse en el cuerpo de la solicitud de punto final de API, puede hacer clic en el botón +.
• Para que los datos se envíen en los parámetros del cuerpo en formato JSON: Es necesario seleccionar el JSON del desplegable correspondiente al Cuerpo de la Solicitud
• Ahora haga clic en Guardar configuración .

Paso 6: Configurar las API REST principales de Joomla [DE PRIMERA CALIDAD]

• Navegue a la pestaña API REST principales de Joomla pestaña y haga clic en el Configurar nueva API .

• Para configurar la API REST de Joomla Core necesitará un token de autenticación de API. Vaya a Usuarios -> Administrar -> Haga clic en un usuario.

• Aquí ve a la Token de API de Joomla pestaña y copie el token.

• Volver a la API REST principal de Joomla Presione la pestaña y pegue el token generado en el campo designado. Ingrese un nombre para esta configuración y luego elija la opción requerida. Punto final desde el menú desplegable. Si es necesario, también puede aplicar Filtros de consulta y configure el Campos de punto final junto con el preferido Formato de salidaUna vez que todo esté configurado, haga clic en el API de prueba botón para verificar la configuración.

• Verás un Respuesta API Si la configuración fue exitosa, haga clic en el Guardar configuración .

• La API REST principal de Joomla Se ha configurado correctamente. Ahora puede copiar el archivo generado. Código corto Seleccione el código de esta sección y colóquelo en cualquier parte de su sitio para mostrar la respuesta de la API directamente en la interfaz.

Artículos Relacionados

• Obtenga más información sobre nuestra extensión API personalizada.
• Sincronización de datos en tiempo real entre Joomla y un sitio web personalizado.
• Implementación de autenticación JWT segura para las API principales de Joomla.