Använd API:et i er Gateway-installation

Varje anrop behöver Gateway-nyckeln från er kundleverans i fältet Authorization. Förvara den i er hemlighetshanterare och skicka den aldrig i loggar eller klientkod.

Authorization: Bearer $MASKERA_GATEWAY_KEY

Skicka in text och få tillbaka en maskerad version. När er policy tillåter återställning innehåller svaret också en återställningsnyckel som kopplar platshållarna till originalvärdena. Gateway skickar inte originaltexten eller återställningsnyckeln till Maskera.

curl -s https://maskera-gateway.ert-natverk.internal/v1/mask \
  -H "Authorization: Bearer $MASKERA_GATEWAY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Min granne Lars bor på Kungsholmen, personnummer 19900101-0000."}'

Svar:

{
  "text": "Min granne [NAMN_1] bor på [PLATS_1], personnummer [PERSONNUMMER_1].",
  "map": {
    "[NAMN_1]": "Lars",
    "[PLATS_1]": "Kungsholmen",
    "[PERSONNUMMER_1]": "19900101-0000"
  },
  "entities": { "NAMN": 1, "PLATS": 1, "PERSONNUMMER": 1 },
  "meta": { "ner": true, "duration_ms": 24, "chars": 62, "policy": "default" }
}

textobligatorisk

Texten som ska maskeras. Minst 1 tecken; standardgränsen är 100 000 tecken och styrs av er policy.

ner

Sätt värdet till false om ni bara vill hitta personnummer, telefonnummer, e-post och kortnummer. Det går snabbare men hittar inte namn och platser, och kräver att er policy tillåter regelbaserad maskering.

return_map

Sätt värdet till false om ni inte behöver återställningsnyckeln. Er policy kan också stänga av nyckeln, och true kan inte kringgå policyn.

Anropet har samma format som OpenAI. Byt bara adressen i er befintliga kod. Gateway ersätter upptäckta personuppgifter före AI-anropet och återställer dem i svaret. AI-tjänstens nyckel ligger i Gatewayns konfiguration, så er applikation behöver aldrig hantera den.

curl -s https://maskera-gateway.ert-natverk.internal/v1/openai/chat/completions \
  -H "Authorization: Bearer $MASKERA_GATEWAY_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [
      {"role": "user", "content": "Sammanfatta: Lars Svensson ringde om fakturan."}
    ]
  }'

I Python är det officiella OpenAI-SDK:t oförändrat: bara base_url byts.

from openai import OpenAI
import os

client = OpenAI(
    api_key=os.environ["MASKERA_GATEWAY_KEY"],
    base_url="https://maskera-gateway.ert-natverk.internal/v1/openai",
)

Felmeddelandet innehåller inte er text. Svaret har det här formatet: {"error": {"message": "Beskrivning av felet"}}. Statuskoden visar vilken typ av fel som uppstod.

Vid för många samtidiga anrop svarar Gateway 503 med fältet Retry-After. Vänta så många sekunder och försök igen.

GET /healthz svarar 200 när processen är igång, och GET /readyz när licensen är giltig och modellen är laddad. Använd dem i ert övervakningssystem.

{ "status": "ok", "version": "1.2.3" }

Kundportalen visar godkända versioner. Fullständig vägledning för uppdatering, verifiering och återställning ingår i kundleveransens driftguide.

Den maskinläsbara OpenAPI-filen kan skapa klientkod och användas i API-verktyg: /gateway/openapi.json.