API es un acrónimo y significa Application Programming Interface y, por lo tanto, designa una interfaz para la programación de aplicaciones. Básicamente, como parte de un sistema o software, una API ofrece a otros sistemas o programas la oportunidad de conectarse, por ejemplo, para acceder a bibliotecas internas del sistema o datos y archivos almacenados.

Tipos de API

Existen cuatro tipos diferentes de API:

• La API orientada a funciones permite que un programa tenga acceso directo al hardware de un sistema, por ejemplo, para activar un controlador de dispositivo de hardware el programa envía una solicitud para abrir un identificador a través de la API del sistema operativo, que envía el valor solicitado al programa a través de su propia interfaz. El identificador también puede activar varias funciones, que luego se pueden llamar a través de otras solicitudes relacionadas.
• La API orientada a archivos permite la comunicación con los medios de almacenamiento de la computadora para que los archivos y las estructuras de carpetas se puedan solicitar, leer o sobrescribir. El sistema operativo es responsable de distribuir y mantener los derechos de acceso.
• La API orientada a protocolos funciona independientemente del hardware y del sistema operativo, la comunicación se realiza a través de protocolos y bibliotecas. Se considera flexible, aunque las solicitudes de varios componentes del programa no son posibles. La implementación de una o dos bibliotecas suele ser suficiente para garantizar el alcance total de la comunicación.
• La API orientada a objetos se utiliza para combinar la funcionalidad de diferentes clases entre sí. Dicha interfaz está vinculada a varias restricciones definidas previamente que se negocian mediante la sintaxis.

Documentación API

Al igual que el software, también se puede desarrollar una interfaz. Si las interfaces anteriores ya no se pueden utilizar con una nueva versión de software, esto se denomina “API en evolución”. Si la interfaz no cambia a pesar de la nueva versión del software, se denomina “API estable”. 

Es importante que una API esté documentada para que la conexión entre los diversos sistemas y programas pueda funcionar.

En tiempos de plataformas y ecosistemas en línea, la documentación de las interfaces de programación de aplicaciones es cada vez más importante. Una API documentada ofrece la posibilidad de agregar servicios y funcionalidades a productos existentes. 

Es importante que los desarrolladores comprendan la interfaz; la documentación con detalles sobre funciones, clases, tipos de retorno, etc., posiblemente enriquecida con tutoriales y ejemplos ayuda a la hora de programar extensiones.

 

La documentación de la API “buena” ofrece las siguientes ventajas:

• Aumentar el alcance digital: En el contexto de las plataformas y ecosistemas en línea, se habla del alcance digital de una API al proporcionar una base para nuevos servicios. Cuanto mayor es el alcance, más usuarios utilizan la API. Alternativamente, también se utiliza el efecto de red.
• Mayor aceptación: Lo mismo aplica una API que a un producto, cuanto mejor funciona, más personas ven valor en su uso y la aceptación aumenta. Si los desarrolladores pueden ampliar el producto original con funciones útiles, aumentará la aprobación tanto de los desarrolladores como de los usuarios.
• Reducción del esfuerzo y los costos de soporte: Una buena documentación de API no solo aumenta el conocimiento, el alcance y la aceptación digital, sino que también reduce el tiempo, el esfuerzo y los costos requeridos para capacitar a los desarrolladores internos o externos. 
• Mantenimiento de software más sencillo: La documentación de la API contribuye al mantenimiento del producto. Ayuda a los desarrolladores a conocer las estructuras, los recursos, los métodos, etc., de modo que las actualizaciones se puedan realizar mejor y más rápidamente.