APIs para Dummies: Todo lo que necesita saber

Una API (Interfaz de Programación de Aplicaciones) es un conjunto de funciones que permite a las aplicaciones acceder a datos e interactuar con componentes de software externos, sistemas operativos o microservicios. Para simplificarlo, una API transmite una solicitud del usuario a un sistema y envía la respuesta del sistema de vuelta al usuario.

Las API se utilizan mucho porque pueden facilitar mucho las cosas y acelerar el proceso de desarrollo de otros sistemas y aplicaciones. Por ejemplo, si estás creando tu propio software y deseas integrar el reconocimiento facial o el procesamiento de pagos, lo mejor es utilizar una API. Solo tienes que conectar tu software con otro. Estas se proporcionan junto con la documentación de la API, un manual para desarrolladores que ayuda a implementar las funcionalidades deseadas.

Al utilizar una API, no es necesario lidiar con ningún código fuente ni siquiera entender cómo funciona. Suena bien, ¿verdad? Genial, echemos un vistazo a cómo lo hacen las API.

Piensa en una API como el «intermediario» entre tu aplicación y el servidor. Le dices a tu aplicación que haga algo por ti; entonces, la aplicación utilizará una API para comunicarse con el servidor web, indicándole qué debe hacer. Esta acción se denomina solicitud. A continuación, el servidor enviará una respuesta que el «intermediario» entregará a tu aplicación.

Veamos un ejemplo menos abstracto. Entras en un restaurante, eliges una mesa con vistas y esperas a que el camarero te tome la comanda. En este caso, el camarero es tu «intermediario», ya que el cocinero no puede tomar tu comanda directamente, pues tiene otras comandas que preparar en la cocina. Le haces una solicitud al camarero, el camarero envía dicha solicitud a la cocina, luego recibe una respuesta —en este caso, tu comanda— y te la lleva a la mesa. ¡Que aproveche!

Incluso la API es una abstracción del servidor web, ya que la aplicación no sabe lo que ocurre en la «cocina», solo cuál será el resultado final. El usuario final sabe que si pide un pastel del menú, recibirá un pastel. Existen muchos tipos de API, dependiendo de para qué estén diseñadas o de su política de publicación. Echemos un vistazo a estos diferenciadores.

Las API son muy útiles. Como hemos mencionado anteriormente, la comunicación entre diversos programas y aplicaciones es esencial para alcanzar un objetivo concreto, por lo que una API se diseña en función de lo que se quiera lograr. Veamos algunos ejemplos:

• Las API de bases de datos facilitan la comunicación entre una aplicación y un sistema de gestión de bases de datos. Por ejemplo, Firebase es una plataforma de aplicaciones web móviles propiedad de Google que permite a los desarrolladores sincronizar y almacenar datos en tiempo real de forma sencilla, sin tener que gestionar servidores ni escribir código del lado del servidor.
• API de sistemas operativos. Incluso los sistemas operativos cuentan con un buen número de API, por ejemplo, la API de Windows o la API del espacio de usuario del kernel de Linux. También puedes encontrar las API proporcionadas por Apple para macOS e iOS, que se presentan en su documentación para desarrolladores.
• Las API remotas interactúan a través de una red de comunicaciones. La red de comunicaciones más común es Internet, por lo que las API suelen diseñarse basándose en estándares web. Pero eso no significa que todas las API remotas sean API web. Aun así, las API web son generalmente remotas, suelen utilizar HTTP para los mensajes de solicitud y definen la estructura de los mensajes de respuesta. Se prefiere que estos mensajes estén en formato XML o JSON, ya que es más fácil para otras aplicaciones analizar la información.
• Las API más utilizadas son las API web, ya que envían solicitudes desde una aplicación web y respuestas desde servidores utilizando HTTP (Protocolo de Transferencia de Hipertexto). Los desarrolladores utilizan estas API web en sus aplicaciones o sitios web, aumentando su funcionalidad y haciéndolas más prácticas para el usuario, como integrar un método de inicio de sesión a través de Facebook o Google, o añadir un mapa utilizando la API de Google Maps.

Algunas API se crean únicamente para uso interno. Esto es especialmente habitual en las grandes empresas. Otras se diseñan como productos destinados a integrarse con cualquier software que utilicen los clientes. Estas son las principales categorías:

Las API privadas se utilizan principalmente dentro de la propia organización, integrándolas en los sistemas y aplicaciones que utilizan sus empleados y mejorando el funcionamiento interno. Aunque parezcan abiertas al público, la interfaz sigue estando disponible solo para quienes pertenecen a la organización, que tiene control total sobre la API. Esto también reduce algunos costes para la organización.

Las API de socios pueden proporcionar fuentes de ingresos adicionales, ya que se comparten con uno o más socios comerciales. Se establece un acuerdo entre dicho socio y el editor. Una API de socio también añade valor al servicio y abre un canal para la venta de productos de gama superior.

Las API públicas están disponibles para cualquier desarrollador externo. Este tipo de API no requieren una relación estrecha entre el usuario y el editor; pueden aumentar la fuente de ingresos, ayudar a llegar a un público más amplio y generar tráfico, además de apoyar muchas causas y una variedad de iniciativas empresariales. Las API públicas pueden ser:

• Abiertas: estas API pueden ser utilizadas por cualquiera como desee, lo que significa que no hay términos ni condiciones restrictivos, no se necesita el consentimiento del editor para usar la API y no hay que pagar por ella. Proporcionan documentación pública a la que pueden acceder los desarrolladores y pueden utilizarse para probar y crear aplicaciones.
• Comerciales: para utilizar estas API, hay que pagar una cuota de suscripción. Para que los usuarios puedan probar y evaluar el producto, los editores suelen ofrecer una prueba gratuita para que el cliente sepa si le conviene o no adquirir una suscripción.

Son de especial interés las API SOAP y las API REST, ya que están muy extendidas. Echemos un vistazo a los conceptos que se esconden tras las siglas:

Las API SOAP (Simple Object Access Protocol) son protocolos de comunicación web y se utilizan para intercambiar información y datos estructurados a través de HTTP/HTTPS. A diferencia de las API REST, SOAP solo admite el formato de datos XML. La mayor parte del intercambio de datos web se realiza a través de REST, pero eso no significa que SOAP vaya a desaparecer pronto, ya que está muy estandarizado, es más seguro y, en ocasiones, permite la automatización.

XML (eXtensible Markup Language) es una herramienta independiente del software o el hardware para almacenar y transportar datos. Cuenta con un conjunto de reglas para estructurar mensajes como registros legibles tanto por humanos como por máquinas. Como se puede ver a continuación, su estructura es similar a la del HTML, pero el lenguaje XML no tiene etiquetas predefinidas, por lo que el autor debe definir tanto las etiquetas como la estructura del documento.

La Transferencia de Estado Representacional (REST) es un estilo de arquitectura creado por Roy Fielding en 2000 para diseñar aplicaciones acopladas a través de HTTP y se utiliza a menudo en el desarrollo de API. Para que un servicio se considere RESTful, no debe infringir estas restricciones.

Los desarrolladores prefieren utilizar REST como alternativa a SOAP porque no implica escribir mucho código para realizar tareas sencillas, a diferencia de SOAP, que requiere crear la estructura XML necesaria cada vez. Los servicios web RESTful utilizan un enfoque diferente. Tratan la información como un recurso representado por una URL única. Por lo tanto, si quieres solicitar un recurso determinado, tendrás que proporcionar su URL utilizando métodos HTTP como GET, POST, PUT, HEAD, DELETE, PATCH y OPTIONS. ¡Puedes encontrar más información sobre estos métodos aquí! A veces puede que necesites enviar datos adicionales junto con la URL para obtener lo que necesitas, como una clave de acceso.

A diferencia de SOAP, REST no se limita a utilizar XML para proporcionar la respuesta. Puedes obtener la información en diferentes formatos, como JSON, XML, CSV, texto sin formato y HTML, que se analizan más fácilmente en función del lenguaje que utilices para tu aplicación.

Aquí tienes una comparación entre JSON y XML:

A menudo oirás a los desarrolladores hablar de las funcionalidades de las diferentes API, pero hay otro aspecto importante del que se habla menos: la documentación. Sin los conocimientos que contiene, una API podría ser perfectamente un montón de jeroglíficos.

La documentación de una API no es un tutorial de videojuego que puedas saltarte con indiferencia y aprender su mecánica sobre la marcha. La documentación contiene instrucciones sobre cómo utilizar e integrar eficazmente dicha API.

Incluso si una API es revolucionaria para los desarrolladores, una documentación deficiente o la falta de conocimiento sobre cómo funciona la harían inútil.

Una documentación bien redactada puede ayudar a ahorrar tiempo y costes de asistencia técnica. La incorporación de nuevos usuarios se vuelve más fácil y estos no necesitarán asistencia técnica para utilizar la API. Una documentación mal redactada puede resultar bastante frustrante tanto para los desarrolladores como para el equipo de asistencia técnica de los editores.

Algunas documentaciones pueden incluir una sección de demostración o un entorno de pruebas donde se pueden probar cosas y ver los resultados en tiempo real. Esto ayuda a los desarrolladores a visualizar lo que hace la API y a comprenderla mejor.

Espero que nuestro «API para principiantes» te haya ayudado a comprender mejor cómo funcionan las API y lo importantes que son en el mundo de la tecnología de la información.

El creciente número de aplicaciones y productos de software, tanto corporativos como de uso personal, necesita métodos de comunicación e intercambio de recursos. Las API satisfacen esa necesidad y son clave para ayudar a la expansión de la tecnología.

¡Echa un vistazo a este artículo sobre API de web scraping para ver algunos ejemplos de API web en acción!