¿Qué es y para qué sirve una API? Aquí las respuestas necesarias
Si cuando alguien te habla de API todavía crees que se refiere al inseparable compañero de Blas en Barrio Sésamo, es que tienes un pequeño problema con lo que crees que sabes de tecnología. Pero eso se va a acabar hoy mismo. Nadie volverá a meterse contigo por una nadería tan sencilla de explicar como esta. Eso sí, debes estar atento. La explicación será tan educativa y entretenida como las de los míticos Epi y Blas, pero algo menos plana y difícil de seguir que cuando nos explicaron, con todo el cariño, qué era “dentro y fuera” en aquel inolvidable capítulo. Pues eso, a por ello, deja “fuera” todo nervio o desazón y pasa “dentro” a aprender para qué sirve una API.
¿Qué es una API?
Para poder explicar para qué sirve una API (Application Programming Interface o Interfaz de Programación de Aplicaciones), primero tenemos que saber qué es. Una API es un conjunto de funciones, procedimientos y subrutinas que ofrece una “biblioteca” para ser utilizadas por otro software. Un momento, esto está quedando un poco técnico. ¿Qué queremos decir con todas estas palabras de peritos especialistas? Bueno, que una API es un conjunto de acciones que nos dan acceso a determinadas tareas de un software, como pueden ser tareas de creación, actualización o borrado de elementos. ¿Mejor?
¿Para qué sirve una API?
Como percibimos en su propia descripción, las APIs se utilizan para hacer uso de funciones ya existentes en otro software. A su vez, distintas aplicaciones pueden hacer uso de las API de cada una para mantener una comunicación de datos entre ellas, de manera transparente para el usuario.
Una API es una forma de dar acceso a una aplicación a un usuario externo, donde dicho usuario solo puede usar y ejecutar ciertas funciones alas cuales el propietario ha dado acceso.
Pongamos un ejemplo cercano: la utilización de un juego en tu móvil. Dicho juego necesita recoger información, como puede ser el nombre, número de teléfono… En vez de pedir que se rellene toda la información manualmente, pide las credenciales de Facebook y se obtienen todos los datos usando su API.
Para qué sirve una API: Pandora FMS API
Pandora FMS utiliza una API externa para integrar aplicaciones de terceros en el uso de la herramienta. Dicha API se utiliza mediante llamadas remotas vía HTTP sobre el fichero “api.php” incluido en “/var/www/html/pandora_console/include” (ruta por defecto).
Como cualquier otra API que se pueda encontrar, existen cierto tipo de restricciones para su uso. Una de esas restricciones es los distintos parámetros que pueden ser utilizados en la llamada a la misma, donde se pueden destacar dos grandes operaciones a realizar, GET y SET, las cuales explicaremos posteriormente.
Existen también restricciones de seguridad referentes a la utilización de la API. Por un lado, el administrador de la herramienta tendrá que configurar tres apartados distintos para el uso de la API por terceros. En primer lugar, tendrá que detallar una lista de IPs desde las cuales se puede hacer uso de la API. Dicha restricción puede hacerse detallando una lista de IPs concretas o, por el contrario, dejando libre el acceso desde cualquier IP posible. En segundo lugar, de manera opcional se puede proporcionar una contraseña para el uso de la API. Adicionalmente, para poder acceder a las acciones de la API se debe de proporcionar un usuario y password válidos dentro de la herramienta en la que queramos usar la API.
Como hemos mencionado anteriormente, existen dos grandes operaciones a realizar mediante la API: GET Y SET.
Mediante las operaciones GET se solicita un listado de datos que varía según la llamada realizada. Dentro de la API de Pandora FMS se pueden solicitar datos sobre agentes, módulos, políticas, gráficas, eventos, alertas, grupos, plugins, tags, estado de servidores… Dentro del repertorio de Pandora FMS se encuentran más de 60 llamadas de tipo GET. Un ejemplo de llamada API GET podría ser cómo obtener la lista de agentes de nuestra máquina:
Donde podemos ver las operaciones “get” y “all_agents”, queremos que nos lo devuelva en formato csv con la contraseña de api “1234” y el usuario “admin” con contraseña “pandora”.
Mediante las operaciones SET podemos crear, actualizar o borrar datos. Al igual que en las operaciones GET, se pueden realizar acciones sobre agentes, módulos, políticas… Existen casos especiales donde se pueden realizar acciones ajenas a la creación, modificación o borrado. En el caso de las políticas también se pueden aplicar políticas ya creadas. Dentro del repertorio de Pandora FMS se encuentran más de 100 llamadas de tipo SET. Un ejemplo de llamada API SET podría ser cómo eliminar un agente en nuestra máquina:
http://127.0.0.1/pandora_console/include/api.php?op=set&op2=delete_agent&id=agente_erroneo&apipass=1234&user=admin&pass=pandora
Donde podemos ver las operaciones “set” y “delete_agent”, el agente que queremos eliminar “agente_erroneo” con la contraseña de api “1234” y el usuario “admin” con contraseña “pandora”.
Enlace a la wiki en español: https://wiki.pandorafms.com/index.php?title=Pandora:Documentation_es:Anexo_API_external
Enlace a la wiki en inglés:
https://wiki.pandorafms.com/index.php?title=Pandora:Documentation_en:Annex_ExternalAPI
Por cierto, si habéis llegado hasta aquí y estáis interesados en mayores matices sobre tecnología y monitorización, ¿qué tal un poco de espacio para charlar sobre lo último en ello? ¿Conoces Pandora FMS? Pandora FMS es un sistema de monitorización flexible, capaz de monitorizar dispositivos, infraestructuras, aplicaciones, servicios y procesos de negocio.
¿Aún quieres saber más sobre la monitorización de sistemas? Por suerte, estás en el lugar indicado para conocer más. En este blog existen decenas de artículos que pueden introducirte en este apasionante mundo. Aquí tienes un link a nuestra página de inicio: https://pandorafms.com/blog/es/
O también puedes conocer directamente Pandora FMS Enterprise si te interesa monitorizar más de 100 dispositivos. Entra aquí: https://pandorafms.com/es/
Incluso puedes enviar cualquier consulta que tengas acerca de Pandora FMS. Hazlo de una manera muy sencilla, gracias al formulario de contacto que se encuentra en la siguiente dirección: https://pandorafms.com/es/empresa/contacto/
Dimas P.L., de la lejana y exótica Vega Baja, CasiMurcia, periodista, redactor, taumaturgo del contenido y campeón de espantar palomas en los parques. Actualmente resido en Madrid donde trabajo como paladín de la comunicación en Pandora FMS y periodista freelance cultural en cualquier medio que se ofrezca. También me vuelvo loco escribiendo y recitando por los círculos poéticos más profundos y oscuros de la ciudad.
Dimas P.L., from the distant and exotic Vega Baja, CasiMurcia, journalist, editor, thaumaturgist of content and champion of scaring pigeons in parks. I currently live in Madrid where I work as a communication champion in Pandora FMS and as a freelance cultural journalist in any media offered. I also go crazy writing and reciting in the deepest and darkest poetic circles of the city.
