Introducción a la gestión de API

Las API (interfaces de programación de aplicaciones) permiten que las aplicaciones se comuniquen entre sí. La biblioteca requests de Python facilita la interacción con las API mediante el envío de solicitudes HTTP y la gestión de respuestas.

En esta lección, aprenderá a utilizar la biblioteca requests para enviar solicitudes a las API y procesar respuestas.

Instalación de requests

Para instalar la biblioteca requests, utilice el siguiente comando en su terminal:

pip install requests

Una vez instalada, puede importarla en sus scripts de Python:

# Importing requests
import requests

print("Requests library imported successfully")

Envío de una solicitud GET

El método GET se utiliza para recuperar datos de una API. Utilice la función requests.get() para enviar una solicitud GET:

# Sending a GET request
import requests

response = requests.get("https://jsonplaceholder.typicode.com/posts/1")
print(response.json())  # Outputs the JSON response

Envío de una solicitud POST

El método POST se utiliza para enviar datos a una API. Utilice la función requests.post():

# Sending a POST request
import requests

payload = {"title": "foo", "body": "bar", "userId": 1}
response = requests.post("https://jsonplaceholder.typicode.com/posts", json=payload)
print(response.json())  # Outputs the response

Gestión de respuestas

La biblioteca requests proporciona varios atributos para gestionar las respuestas, como los siguientes:

• response.status_code: código de estado HTTP.
• response.json(): datos de la respuesta en formato JSON.
• response.text: contenido sin procesar de la respuesta.

# Handling responses
response = requests.get("https://jsonplaceholder.typicode.com/posts/1")
if response.status_code == 200:
    print("Success:", response.json())
else:
    print("Failed with status code:", response.status_code)

Adición de parámetros de consulta

Puede pasar parámetros de consulta a las API mediante el argumento params en una solicitud GET:

# Adding query parameters
params = {"userId": 1}
response = requests.get("https://jsonplaceholder.typicode.com/posts", params=params)
print(response.json())

Adición de encabezados

Los encabezados permiten enviar información adicional, como claves de API o tipos de contenido, junto con sus solicitudes:

# Adding headers
headers = {"Authorization": "Bearer YOUR_API_KEY"}
response = requests.get("https://jsonplaceholder.typicode.com/posts", headers=headers)
print(response.status_code)

Gestión de errores

La biblioteca requests proporciona un sistema integrado de gestión de excepciones para los errores relacionados con la red:

# Handling errors
try:
    response = requests.get("https://jsonplaceholder.typicode.com/invalid")
    response.raise_for_status()
except requests.exceptions.HTTPError as err:
    print("HTTP error occurred:", err)
except requests.exceptions.RequestException as err:
    print("Request error occurred:", err)

Errores comunes con requests

Estos son algunos errores que debe evitar:

• No gestionar los errores HTTP con response.raise_for_status().
• Incluir información sensible, como claves de API, directamente en el script.
• Olvidar especificar el método HTTP correcto (por ejemplo, GET o POST).

¿Qué hemos aprendido?

En esta lección, aprendió:

• Cómo instalar e importar la biblioteca requests.
• Cómo enviar solicitudes GET y POST a las API.
• Cómo gestionar respuestas, añadir parámetros de consulta y encabezados, y gestionar errores.

¡Buen trabajo! Pasemos al siguiente tema.