Search

En JosSecurity agradecemos cualquier ayuda para poder mantener este proyecto, si deseas donar por favor da clic en el botón de al lado y te daremos algunas opciones para hacerlo.

Conexión por medio de API

Configuración

Para poder ejecutar una conexión API deberás tener la versión 1.6.2 o superior de JosSecurity, esta versión te permitirá integrar todo de manera fácil.

Para poder admitir conexiones API necesitarás modificar tu archivo ENV dentro de tu sistema y agregar la siguiente línea:

				
					API=1
				
			

Es obligatorio tener el número 1 para poderlo activar, sino está la variable API o tiene otro número, la conexión API no podrá ser efectuada.

Una vez hecho esto te explico qué necesitarás para poder usar esta API. Su estructura es la siguiente:

Cada instrucción de cmd necesita al menos un arreglo (a excepción de “test”), para cada arreglo se le deberá enviar un método GET con los datos “arg…” de manera consecuente.

Es decir, deberás poner arg1, arg2, arg3… Dependiendo de las necesidades de la instrucción.

Si deseas probar consultas por método postman o por pipedream, te damos un archivo donde podrás practicar cada línea de comando a través de tu instalación dentro de Localhost.

Uso de API´s personalizadas

A partir de la versión 2.3.4 de JosSecurity, tú puedes crear un archivo llamado custom.php en la carpeta API para poder agregar tus propios Jossitos y así poder integrarlos en la API.

Si tienes el sistema de administración que te da JosSecurity, podrás crear el archivo custom.php con tan solo un clic, deberás abrir en el menú de navegación la pestaña “configuraciones” y le deberás dar clic en “Archivos API”.

Una vez abierta la pestaña, te saldrá la opción “Crear archivo”, dale clic y automáticamente se creará el archivo.

Para integrar tus jossitos solo deberás poner “case” al igual que las instrucciones que deseas ejecutar, el sistema lo integrará automáticamente a la API principal. A continuación, te dejaré un ejemplo:

				
					//Caso de pruebas
        case "test2":
            echo "\n\tExtensión de la API está funcionando.";
            break;
				
			

API pública

A partir de la versión 2.3.4 de JosSecurity, el sistema de administración te permite activar el uso de API´s en modo de producción, tan solo deberás dar clic en el botón “Activar API pública” en la página de inicio del sistema de administración de JosSecurity y se creará un archivo en la carpeta public que enlazará el archivo API y el archivo custom.php para poder ser consultados de manera externa.

Conexión por medio de API