Uso de Módulos del API

El uso del API es totalmente versátil para realizar peticiones de tipo POST o de tipo GET, en varios ejemplos de esta documentación usamos capturas de pantalla de Postman o ejemplos de línea de comandos para mostrar el funcionamiento de los diferentes módulos.

Los módulos del API se organizan en directorios, para los módulos de contribución se deben ubicar en la siguiente ruta /api/contrib

Los otros módulos son meramente del core del API.

Usaremos el módulo de clave para mostrarle el uso y la estructura del módulo.

• Debe existir un directorio con el nombre del módulo ubicado en /api/contrib
• Dentro de clave debe existir un archivo llamado module.php
• La función _bootMeUp debe ser completada con el nombre del módulo, como este modulo es ejemplo el _bootMeUp se debe llamar ejemplo_bootMeUp
• La función _init() de igual manera debe llevar el nombre del módulo ejemplo_init()
• El ejemplo_init() es el que contiene un array de tareas.

En el siguiente código veremos que $paths es el Array con las funciones, cuando hacemos un GET enviamos un w este es el nombre del módulo o la carpeta, ahora vemos en $paths un 'r' => 'hola', esto quiere decir que si yo quiero llegar a usar ese módulo debo enviar un w=clave y un r=ejemplo el 'action' => 'module_hola', quiere decir que ejecutará la función module_hola, 'access' => 'users_openAccess' quiere decir que el usuario no requiere estar logueado para ejecutar la función, este puede ser users_openAccess o users_loggedIn en el caso de requerir logueo, 'file' => 'ejemplo.php' quiere decir que la función module_hola se encuentra en el archivo ejemplo.php ubicado en el directorio ejemplo y esa función será la que use los parámetros enviados y deberá retornar el resultado.

En el caso que queramos usar el método con parámetros les muestro el ejemplo de un_usuario, este va a ejecutar la acción unUsuario ubicada en ejemplo.php, pero este caso vamos a pedir unos parámetros que son requeridos "req" => true

Vamos a pedir un nombre y apellido

Por lo tanto la consulta para llegar a ese módulo seria la siguiente:

https://api-demo.crlibre.org/api.php?w=ejemplo&r=un_usuario&nombre=Walner&apellido=Borbon