Z-Mask-API zur Maskierung personenbezogener Daten

Integrieren Sie Textmaskierung und Seitenkontingent-Abfragen mit einem Z-Mask-API-Schlüssel. Starten Sie mit serverseitigen REST-Anfragen und halten Sie Zugangsdaten aus dem Browsercode heraus.

API-Schlüssel verwalten

Kontobezogenen API-Schlüssel erstellen

Melden Sie sich im Arbeitsbereich an und öffnen Sie API & Dienst, um einen Z-Mask-API-Schlüssel zu erstellen. Speichern Sie ihn in der Geheimnisverwaltung oder Umgebung Ihres Servers und senden Sie ihn als Bearer-Token. Widerrufen Sie nicht mehr benötigte Schlüssel.

API-Schlüssel gehören nicht in Browserpakete, URLs, öffentliche Repositories oder Protokolle. Aufrufe unterliegen den Kontoberechtigungen und Nutzungsgrenzen des Schlüsselinhabers. Die Beispiele nutzen fiktive Eingaben und eine Umgebungsvariable statt echter Zugangsdaten.

Text vom Server aus maskieren

Senden Sie JSON mit einem text-Feld an POST /v1/mask. Prüfen Sie Ergebnis und erkannte Entitäten, bevor Sie den Text weiterleiten. Verwenden Sie synthetische Testdaten beim Einrichten der Integration.

curl "https://api.zmask.zcntech.com/functions/v1/masking-gateway/v1/mask" \
  -H "Authorization: Bearer $ZMASK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"Kontaktieren Sie Anna Schneider unter anna.schneider@example.com."}'

Seitenkontingent prüfen

Rufen Sie GET /v1/balance mit demselben Schlüssel auf, um vor einer Dokumentenverarbeitung das Seitenkontingent zu prüfen. Eine Abfrage reserviert keine Kredite; gleichzeitige Anfragen können das verfügbare Kontingent ändern.

curl "https://api.zmask.zcntech.com/functions/v1/masking-gateway/v1/balance" \
  -H "Authorization: Bearer $ZMASK_API_KEY"

Fehler behandeln, ohne Daten offenzulegen

Prüfen Sie HTTP-Statuscodes vor der Verwendung einer Antwort. Behandeln Sie abgelaufene oder widerrufene Zugangsdaten, unzureichende Kredite und Verarbeitungsfehler in Ihrer Anwendung. Wiederholen Sie kostenpflichtige Dokumentenanfragen nach einem Timeout nicht ungeprüft.

Halten Sie Anfrageinhalte und Originaldokumente aus Analyse- und Fehlerprotokollen heraus. Prüfen Sie zur Fehlerdiagnose den Verarbeitungsverlauf des Kontos. Besprechen Sie eine lokale Installation mit unserem Team bei besonderen Netzwerk- oder Aufbewahrungsanforderungen.