¿Cómo llamar a una API Rest?

Estamos seguros de que las API te deben sonar de algo o que han sido útiles en el desarrollo de tus programas de código. ¿Recuerdas cómo llamar a una API desde tu consola de programación? Si la respuesta es negativa, deberás seguir realizando ejercicios prácticos que involucren el uso de la herramienta de las API o la HTTP, pero si quieres saber los básicos, te recomendamos seguir leyendo este artículo sobre cómo llamar a una API.

¿Qué es una API?

Como te comentamos en el post acerca de qué es una API y para qué sirve, las siglas en inglés representan una Application Programmation Interface o Interfaz de programación para las aplicaciones. Estas son las encargadas de establecer la comunicación entre softwares o páginas y permiten, desde otro programa o aplicación, el acceso a una o todas las partes que constituyen a cualquier programa. Las Rest API posibilitan el proceso para realizar peticiones a otra página o plataforma con la llamada API.

¿Qué es una API Rest?

En el caso del presente artículo, definiremos el proceso para definir qué es una API Rest, por tanto es importante, antes de aprender cómo llamar a una API Rest, recordar este concepto. El atributo Rest que acompaña la API se refiere a la representación de un estado, es decir, cuando usamos este atributo obtendremos un representación del estado cuando realizamos peticiones; en este caso, a una página de internet o a un servidor web.

¿Cómo llamar a una API Rest?

Ahora que ya recuerdas qué es una API y una API Rest, estás listo para aprender cómo llamar a una API Rest. Por tanto, te presentaremos los elementos necesarios que necesitas incluir en la primera llamada API, así como una representación gráfica, en forma de código, de este mismo proceso.

Establecer el fichero e importar la librería

En un principio, para aprender cómo llamar deberás establecer un fichero para tu programa de código en tu IDE o consola donde estás escribiendo el código. Este se conforma según el lenguaje de programación que estás empleando. En este caso, será en Python, por lo que lo llamaremos con la extensión .py de esta manera: primera_llamada.py para la API Rest.

Después de establecer el fichero y otros procesos que has debido establecer en la programación, tal como el entorno virtual o el repositorio local y remoto, tendrás que importar la librería requests, que se utiliza para trabajar con API Rest, de la siguiente forma: import requests.

Obtener la APIKey

Lo primero que necesitas en el proceso de cómo llamar a una API es tener integrado la APIKey o clave, que te servirá para identificar tu programa. Para obtenerla, deberás seguir los pasos establecidos de la página o servidor web donde localizarás los recursos.

En el caso de CoinAPI.io, deberás dar tu dirección de correo, donde te llegarán todos los pasos y la clave misma para ejecutar la API en tu programa de código.

Integrar la variable de headers

Para que sea funcional, también tendrás que agregar una cabacera a la llamada de la API que estás realizando. La explicación de este proceso también lo encuentras en el servidor web en el que se encuentra la API o en la documentación oficial de la librería requests.

En la cabecera, deberás instalar un diccionario con la siguiente instrucción: headers = {‘user-agent’: ‘my-app/0.0.1’}

Buscar y agregar la URL

Después de integrar las variables de la herramienta headers en tu primera llamada a la API, deberás buscar y agregar la URL de tu página o servidor web. En el caso del ejemplo sobre las criptomonedas, que es un recurso para aprender cómo llamar, tienes que dirigirte a la sección de Market Data – Rest Api, donde en la sección de Sandbox encontrarás la URL que deberás integrar. Este deberá formatearse si es necesario.

Objeto requests y response

En este apartado tendrás que hacer uso del objeto requests y response de la librería requests para la API Rest con el método requests.get, donde pasarán parámetros necesarios para la llamada, como la URL y los headers que hemos establecido en un paso anterior. Estos parámetros tienen un valor por defecto para la llamada API.

Representación de cómo llamar a una API Rest

A continuación, te traemos una representación de cómo llamar a una API Rest de una plataforma y/o servicio web llamado CoinApi.io, que sirve para rastrear las trayectorias de las criptomonedas alrededor del mercado en todo el mundo.

#llamar a una API Rest o Rest API

import requests

apikey = «número del código de la apikey»

headers = {

«X – CoinApi – Key»: apikey

}

url = f «url donde se encuentra la API» #Rest API

respuesta = requests.get (url, headers = headers)

print (respuesta.text)

De esta manera, ya sabes cómo llamar a una API Rest.

¿Cuál es el siguiente paso?

Como ya sabes qué es y cómo llamar a una API, estás más cerca de comunicar aplicaciones por medio de un programa y no por parte de un usuario. En resumen, las API hacen eso: comunicar aplicaciones y programas.

Si quieres seguir aprendiendo acerca de APIs, programación y escritura de código, entre otros procesos del mundo IT, te recomendamos revisar el temario del Aprende a Programar desde Cero Full Stack Jr. Bootcamp. Esta es una oportunidad perfecta para convertirte en programador en muy pocos meses. ¡Anímate a escribir código con Rest API!