API ¿qué es y para qué sirve?

Sin entrar en demasiados tecnicismos, daremos una definición medio formal de lo que son: La interfaz de programación de aplicaciones, abreviada como API del inglés (Application Programming Interface) , es un conjunto de subrutinas, funciones y procedimientos que ofrece ciertos “servicios” para ser utilizados por otro software como una capa de abstracción.

Vamos a ver como de una manera muy sencilla podemos consultar los dominios que tenemos en nuestro Panel de gestión preferido 😉 @neodigit que nos ofrece un API https://developers.neodigit.net para poder realizar algunas tareas desde nuestra linea de comandos (POWERSHELL) en este caso, que $deity me perdone por hacer esto con Windows, pero me pareció una buena manera de desmitificar su uso… espero que os guste y anime para que os hagáis unos cuantos “scripts” y lo compartáis con nosotros.

Bueno, lo primero es abrir el POWERSHELL ISE. Tiene esta pinta:

PowerShell ISE

Desde esta linea de comandos tenemos un editor que genera ficheros con extensión .ps1 y añadiendo unas lineas de código como las que siguen, podemos por ejemplo, listar los dominios que tenemos en nuestro panel ordenados por su estado y fecha de caducidad. Solamente pretendo hacer un ejercicio básico, hace casi 20 años que no tiro una sola linea de código 🙂 pero eso es otra historia, para mostrar la potencia del uso de los API y como podemos automatizar, completar la falta de funcionalidad o adaptar a nuestras necesidades determinadas gestiones por su rapidez.

Expliquemos algunos conceptos para que nuestro script de listado de dominios funcione:

  1. Necesitaremos nuestra llave de API o API-Key, que podemos encontrarlas en el panel accediendo a: https://panel.neodigit.net/api-consumers y desde ahí generaremos un “token” o palabra clave que usaremos para las llamadas que hace nuestro script y declaramos en la variable token. Nota: Este “token” del ejemplo es uno generado en mi cuenta y está expirado, no sirve. Como recomendación adicional si podéis además limitar el acceso por IP la cosa quedará “niquelada”:

    Alta consumidores de api

  2. Declaramos el entorno al que lanzaremos nuestras peticiones, no hay mucha mística en estas variables pero las he separado para que veáis como se construye la URL donde cursaremos esas peticiones, recordad que podéis ver la documentación y ejemplos de llamadas en https://developers.neodigit.net:
  3. Cursamos la petición y recogemos los resultados:
  4. Preparamos la salida:
  5. Y finalmente la sacamos por pantalla ordenada: