Blog

qué es una API

¿Qué es una API y cómo leer sus respuestas?

Diseño y desarrollo web

Cuando nos iniciamos en el mundo del desarrollo, ya sea web o no, nuestro camino en ocasiones se complica, y esto hace que nos cueste mas avanzar y crecer como desarrolladores. Ocurre especialmente cuando comenzamos a trabajar con lenguajes de programación un poco mas complicados, como podrían ser los lenguajes de programación orientados a objetos, aunque, con paciencia y esfuerzo, siempre podremos conseguir aquello que nos propongamos.

Sin embargo, existe algo muy importante, a lo que seguramente os tengáis que enfrentar si aún no lo habéis hecho. Os hablamos de las APIs y de la creación de las mismas. ¿Qué esto de la API?

Pues el concepto sería “Application Programming Interface”, o lo que en español vendría siendo, una Interfaz de Programación de Aplicaciones, junto con un montón de información como características, definiciones, etc que quizás te parezcan aburridas y, por ello, vamos a explicarte de otra manera qué es una API.

¿Qué es una API?

De una forma muy sencilla, una API sería como un conjunto de instrucciones de las cuales disponemos para utilizar cuando queramos y desde donde queramos. Estas instrucciones serán utilizadas por software y les permitirá a estos comunicarse entre sí.

Un dato curioso es que una API no es solamente una herramienta que le va a permitir a un software obtener datos, sino que, en ocasiones, se comercializa como un producto, siendo a veces hasta raro la empresa que no cuenta con una API, ya que muchas veces el pocisionamiento de la marca se apoya incluso en una ella.

Problemas comunes de una API

¿Qué inconvenientes podemos encontrarnos ante el uso de una API?

  • La seguridad de una API. Podríamos decir que si contamos con una API, estamos dejando una puerta abierta para que entren en nuestra empresa. Claro está que el tema hoy en día no es como hace unos años y que, actualmente, se cuentan con métodos y con mas información que harán a nuestra API mas segura. Aún así, el riesgo siempre estará presente.
  • La claridad en cuanto al uso de las APIs. Algunas empresas usan las APIs como último (en ocasiones, único) recurso, y, de vez en cuando, no proporcionan una documentación completa o bien ordenada, haciendo que el uso de la misma sea algo complicado.
  • Ciertas APIs carecen de calidad. Éstas, en ocasiones, no son consideradas como importantes” dentro de las empresas, siendo esto un tanto preocupante.

Posibles respuestas de una API

A continuación, veremos cuáles son las posibles respuestas que una API puede darnos. Todas las respuestas se basan en códigos, según los códigos de estado o status code del protocolo HTTP. Siendo entonces estos los posibles respuestas y su significado:

Código de respuestaDescripción
200 OKSolicitud aceptada. La respuesta contiene el resultado. Este es un código de respuesta general a cualquier solicitud.
201 CREATEDLas operaciones PUT o POST devuelven este código de respuesta e indica que se ha creado un recurso de forma satisfactoria.
204 NO CONTENTIndica que se ha aceptado la solicitud, pero no había datos para devolver. Este respuesta se devuelve cuando se ha procesado la solicitud, pero no se ha devuelto ninguna información adicional acerca de los resultados.
400 BAD REQUESTLa solicitud no fue válida. Este código se devuelve cuando el servidor ha intentado procesar la solicitud, pero algún aspecto de la solicitud no es válido. La información acerca de la solicitud se proporciona en el cuerpo de la respuesta e incluye un código de error y un mensaje de error.
401 UNAUTHORIZEDEl servidor de aplicaciones devuelve este código de respuesta cuando está habilitada la seguridad y faltaba la información de autorización en la solicitud.
403 FORBIDDENIndica que el cliente ha intentado acceder a un recurso al que no tiene acceso. Podría producirse si el usuario que accede al recurso remoto no tiene privilegios suficientes.
404 NOT FOUNDIndica que el recurso de destino no existe. Esto podría deberse a que la URL no está bien formada o a que se ha eliminado el recurso al que se pretendía acceder.
405 METHOD NOT ALLOWEDSe produce cuando el recurso de destino no admite el método HTTP solicitado.
406 NOT ACCEPTABLEEl recurso de destino no admite el formato de datos solicitado en la cabecera de Accept o el parámetro accept. Es decir, el cliente ha solicitado la devolución de los datos en un determinado formato, pero el servidor no puede devolver datos en ese formato.
409 CONFLICTIndica que se ha detectado un cambio conflictivo durante un intento de modificación de un recurso. El cuerpo de la respuesta contiene más información.
415 UNSUPPORTED MEDIA TYPEEl recurso de destino no admite el formato de datos del cuerpo de la solicitud especificado en la cabecera de Content-Type.
500 INTERNAL SERVER ERRORSe ha producido un error interno en el servidor. Esto podría indicar un problema con la solicitud o un problema en el código del lado del servidor. Se puede encontrar información acerca del error en el cuerpo de respuesta.

En conclusión

Podemos decir que las APIs se han convertido en una herramienta utilizada por gran cantidad de empresas, siendo éstas de gran uso en muchos de los casos y suponiendo un ahorro de tiempo y esfuerzo importante a la hora de desarrollar nuestros proyectos. Conocer todos los status code se nos puede hacer una tarea muy pesada, por ello, en este artículo hemos visto algunos de los mas frecuentes y utilizados a la hora de desarrollar o utilizar una API.

Existen sitios web como httpstatuses a partir de los cuales podremos consultar el significado de cualquier status code sin apenas esfuerzo.

Y tú ¿te has enfrentado al reto de crear una API?, ¿has utilizado alguna? ¡Cuentanos tu experiencia! 🙂

¡Si te ha gustado comparte y haz comunidad!