Autenticación con API Key

Implementación de IA en producción con FastAPI

Matt Eckerle

Software and Data Engineering Leader

¿Por qué asegurar las APIs?

Bloquea accesos no autorizados
Protege endpoints con autenticación por API key

Una caja fuerte segura

Cómo funcionan las API keys

Como una contraseña digital para la API
Se envía en los headers de la petición
Se verifica antes de acceder a los endpoints

Diagrama de flujo que explica cómo funcionan las API keys

Entender APIKeyHeader

from fastapi import FastAPI
from fastapi.security import APIKeyHeader
header_scheme = APIKeyHeader(

                      name="X-API-Key",

                      auto_error=True

                 )

Autenticar un endpoint

from fastapi.security import APIKeyHeader
from fastapi import Depends, HTTPException


header_scheme = APIKeyHeader(name="X-API-Key",
                             auto_error=True)

API_SECRET_KEY = "your-secret-key"


@app.get("/items/")
def read_items(
    api_key: str = Depends(header_scheme)
):

    if api_key != API_SECRET_KEY:
        raise HTTPException(
            status_code=403,
            detail="Invalid API key")

    return {"api_key": api_key}

ApiKeyHeader
Depends añade el esquema de header
HTTPException para excepciones
Define el header de la API key y la clave secreta
Valida API keys con test_api_key
Lanza 403 si no coincide con API_SECRET_KEY

Autenticar una app

def verify_api_key(api_key: str = Depends(header_scheme)):
    if api_key != API_KEY:
        raise HTTPException(status_code=403,  detail="Invalid API key")
    return api_key


app = FastAPI(
    dependencies=[Depends(verify_api_key)]
)

@app.post("/predict")
def predict_sentiment(text: str):

    return {
        "text": text,
        "sentiment": "positive",
        "status": "success"
    }

Probar el endpoint

Comando con API key no válida:

curl -X POST \
  http://localhost:8000/predict \
  -H "X-API-Key: wrong-key" \
  -H "Content-Type: application/json" \
  -d '{"text": "This product is amazing!"}'

Comando con API key válida:

curl -X POST \
  http://localhost:8000/predict \
  -H "X-API-Key: your-secret-key" \
  -H "Content-Type: application/json" \
  -d '{"text": "This product is amazing!"}'

Salida con clave no válida:

{"detail":"Invalid API key"}

Salida con clave válida:

{"text":"This product is amazing!",
 "sentiment":"positive",
 "status":"success"}

¡Vamos a practicar!

Implementación de IA en producción con FastAPI