¿Qué es una API?

Tabla de contenidos

API: definición en informática y ejemplos

API es el acrónimo inglés “Application Programming Interface”, es decir, “Interfaz de Programación de Aplicaciones”.

Una «interfaz» es la forma en que dos aplicaciones o servicios se comunican entre sí. Lo hacen exponiendo al resto de aplicaciones el conjunto de servicios disponibles en cada una y cómo se deben acceder.

A la serie de estos servicios, se le denomina API. Por eso, estas sirven para que una aplicación pueda interactuar con otra.

Ejemplos de cómo funcionan las API

Caso 1: Agenda de reservas para MiRestaurante

El restaurante MiRestaurante ha desarrollado una aplicación para hacer reservas. Ahora, quieren hacer que los usuarios puedan hacer reservas desde la Agenda.

Entonces, escriben una API que expone un servicio para el intercambio de datos relacionados con las reservas.

En lenguaje natural

Mi aplicación de Agenda puede ser programada para que cuando detecta que la entrada contiene “comer en MiRestaurante” automáticamente utilice su API para reservar. Así, lo único que tengo que hacer es introducir la entrada en mi agenda, y las aplicaciones se ocupan del resto mediante las API.

En lenguaje técnico

Si guardas una entrada en la agenda que contenga: “Comer en MiRestaurante”, acceder mediante un POST, a la URI: http://mirestaurante.com/api/reservar. Así, enviará la identificación, el número de comensales, la fecha y hora de la reserva.

Caso 2: Conexión entre dos Help Desks

La empresa MiEmpresa presta un servicio de soporte TI a diferentes clientes, y utiliza el help desk de ServiceTonic. Pero, las incidencias relacionadas con impresoras son derivadas a un proveedor externo, el cual usa su propia herramienta de help desk.

Lenguaje natural

Tanto ServiceTonic como la herramienta del proveedor tienen una API para gestionar las incidencias.

Cuando un cliente abre una incidencia relacionada con, por ejemplo, impresoras en ServiceTonic, la aplicación accede a la API de la herramienta del proveedor y crea un ticket. Cuando el proveedor finaliza la incidencia, su herramienta de help desk accede a ServiceTonic vía API, introduce la solución y cambia el estado de la incidencia. Así, cada empresa puede utilizar su propia herramienta de help desk. Lo único que hay que hacer es conectar ambas herramientas mediante sus respectivas API.

Lenguaje técnico

En ServiceTonic, se debe definir una regla de negocio para que al crear una incidencia con categoría “Impresora” se pueda accedar mediante un POST a la URI http://proveedor.com/api/incidencias, enviando la identificación y los datos de la incidencia.

Y, en el help desk del proveedor, se debe acordar que cuando se solucione la incidencia se acceda, mediante un PUT, a la URI http://cliente.myservicetonic.com/api/v1/tickets/id. Así, se enviará la solución y el nuevo estado al help desk.

Beneficios del conector API

Los beneficios de contar con una API son principalmente dos:

Permiten la reutilización de código, reduciendo los tiempos y costes asociados al desarrollo de aplicaciones.
Incrementan la interoperabilidad entre aplicaciones, con el ahorro de costes que esto supone, ya que las máquinas se comunican información entre sí más rápido que los humanos.

ServiceTonic y las API REST

REST viene de “Representational State Transfer” y significa “Transferencia de Estado Representacional”.

La API REST se basa en un protocolo sin estado de cliente-servidor.

ServiceTonic incluye una API REST para poder:

Acceder a ServiceTonic desde otras aplicaciones.
Acceder a múltiples e integrar múltiples instalaciones de ServiceTonic.
Abrir una transferencia bidireccional de tickets e información entre diferentes servicios de su Service Desk, utilidades «out of the box».