Web Services: lado cliente (requests)
Consume web services desde Python con la librería requests: peticiones GET y POST, interpretar la respuesta con status_code y .json(), enviar parámetros y autenticarte con headers y tokens.
terminal
La librería requests
Desde el lado del cliente, queremos hacer solicitudes a un servidor que expone un web service. En Python, la librería requests es la herramienta estándar para eso: nos deja hacer requests HTTP y ya integra la serialización JSON.
Se instala una sola vez desde la terminal:
python
python3 -m pip install requestsLuego, hacer una petición GET es tan simple como llamar a requests.get(url):
python
import requests respuesta = requests.get('https://api.github.com')print(respuesta) # <Response [200]>requests.get(url) devuelve un objeto Response. Toda la información de la respuesta (código de estado, contenido, headers) vive dentro de ese objeto.
Nota
Cargando Quiz...
code
La respuesta: status_code y .json()
Del objeto Response nos interesan sobre todo dos cosas: si la consulta salió bien, y el contenido que devolvió.
.status_code→ el código de estado HTTP (200, 404, 500…)..json()→ convierte el cuerpo de la respuesta (texto JSON) en un objeto Python (dictolist)..text→ el cuerpo crudo como string..headers→ un diccionario con los headers de la respuesta.
python
import requests BASE = 'https://dummyjson.com/'respuesta = requests.get(BASE + 'recipes/') print(respuesta.status_code) # 200 data = respuesta.json() # dict de Pythonprint(data.keys()) # dict_keys(['recipes', 'total', ...])print(data['recipes'][0]['name'])schema
URL base, endpoints y parámetros
Casi todas las APIs comparten una URL base (un prefijo común) y luego distintos endpoints (rutas) para cada recurso. La consulta final es BASE + endpoint.
python
import requests BASE = 'https://dummyjson.com/' respuesta = requests.get(BASE + 'recipes/') # lista de recetasrespuesta = requests.get(BASE + 'products/') # lista de productosPara enviar parámetros de consulta (la query string) no hace falta armar la URL a mano: le pasamos un diccionario al argumento params y requests construye el ?clave=valor&... por nosotros.
python
code
POST: enviar datos al servidor
Cuando queremos crear o enviar información usamos requests.post. Además de la URL, le pasamos los datos: en el cuerpo (data= o json=) de la request.
python
import requests BASE = 'https://dummyjson.com/' nuevo_producto = { 'title': 'Comida de Pepa', 'description': 'Alimento esencial de una tortuga', 'price': 2233,} respuesta = requests.post(BASE + 'products/add', data=nuevo_producto)print(respuesta.status_code)print(respuesta.json())Diferencia clave: en GET los datos van en la URL (vía params), pensados para pedir. En POST los datos van en el cuerpo (vía data/json), pensados para enviar o crear.
Nota
tune
Autenticación con headers
Muchos endpoints son privados y exigen identificarte. La forma habitual es enviar un token en los headers de la request, bajo la clave Authorization.
Un flujo típico: primero pides un token (login), y luego lo usas en las siguientes consultas.
python
import requests # 1) Obtener el token con un POST de loginlogin = requests.post( 'https://dummyjson.com/auth/login', data={'username': 'emilys', 'password': 'emilyspass'},)TOKEN = 'Bearer ' + login.json()['accessToken'] # 2) Usar el token en los headers de la siguiente requestheaders = {'Authorization': TOKEN}