Autentisering med API-nyckel

Driftsättning av AI i produktion med FastAPI

Matt Eckerle

Software and Data Engineering Leader

Varför säkra API:er?

Stoppa obehöriga användare
Skydda API-endpoints med API-nyckelautentisering

Ett säkert valv

Hur API-nycklar fungerar

Som ett digitalt lösenord för API:et
Skickas i begärans-headers
Verifieras innan åtkomst till endpoints

Flödesdiagram som förklarar hur API-nycklar fungerar

Förstå APIKeyHeader

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

                      name="X-API-Key",

                      auto_error=True

                 )

Autentisera en 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 lägger till header-schema
HTTPException för undantag
Definierar API-nyckel-header och hemlig nyckel
Validerar API-nycklar med test_api_key
Returnerar 403 om nyckeln inte matchar API_SECRET_KEY

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

Testa endpointen

Kommando med ogiltig API-nyckel:

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

Kommando med giltig API-nyckel:

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

Utdata med ogiltig nyckel:

{"detail":"Invalid API key"}

Utdata med giltig nyckel:

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

Nu kör vi en övning!

Driftsättning av AI i produktion med FastAPI