API-sleutelauthenticatie

AI in productie brengen met FastAPI

Matt Eckerle

Software and Data Engineering Leader

Waarom API's beveiligen?

Houd onbevoegden buiten
Beveilig API-eindpunten met API-sleutelauthenticatie

Een beveiligde kluis

Hoe API-sleutels werken

Als een digitaal wachtwoord voor onze API
Verstuurd in requestheaders
Gecontroleerd vóór toegang tot eindpunten

Stroomschema dat uitlegt hoe API-sleutels werken

APIKeyHeader begrijpen

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

                      name="X-API-Key",

                      auto_error=True

                 )

Een eindpunt authenticeren

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 voegt headerschema toe
HTTPException voor uitzonderingen
Definieert API-sleutelheader en geheime sleutel
Valideert API-sleutels met test_api_key
Geeft 403 als de sleutel niet overeenkomt met API_SECRET_KEY

Een app authenticeren

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"
    }

Het eindpunt testen

Commando met ongeldige API-sleutel:

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

Commando met geldige API-sleutel:

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!"}'

Uitvoer bij ongeldige sleutel:

{"detail":"Invalid API key"}

Uitvoer bij geldige sleutel:

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

Laten we oefenen!

AI in productie brengen met FastAPI