'So automatisieren Sie die PII-Redaktion mit einer REST-API'
Wenn Ihre Anwendung von Benutzern hochgeladene Fotos, Flottenaufnahmen, Schadendokumentationen oder andere visuelle Medien akzeptiert, gehört die Schwärzung in die Upload-Pipeline. Gesichter, Nummernschilder, Dokumente, Bildschirme und Abzeichen tauchen oft in Dateien auf, die niemals dazu gedacht waren, persönliche Daten preiszugeben.
Dieser Leitfaden behandelt die PiiBlur REST API: Medien hochladen, Status überprüfen, Ergebnisse herunterladen, Webhooks einrichten und eine Batch-Pipeline erstellen. Alle Beispiele verwenden cURL, um sprachunabhängig zu bleiben. Die vollständige Endpunktreferenz finden Sie im API-Dokumentation. Nähere Beispiele finden Sie auf den Seiten Gesichtsunschärfe-API, API zum Verwischen von Nummernschildern, Bildredaktions-API und Video-Redaktions-API.
Authentifizierung und Basis-URL
Für jede Anfrage ist ein Bearer-Token erforderlich. Generieren Sie einen API-Schlüssel aus dem API-Bereich Ihres PiiBlur-Dashboards.
curl -X GET https://piiblur.com/api/v1/usage \
-H "Authorization: Bearer YOUR_API_KEY"
Eine erfolgreiche Antwort bestätigt Ihren Schlüssel und gibt die aktuellen Nutzungs- und Planlimits zurück. Alle Endpunkte leben unter https://piiblur.com/api/v1/.
Hochladen von Medien zur PII-Redaktion
Senden Sie ein Bild oder Video mit einer mehrteiligen POST-Anfrage. Geben Sie mindestens eine PII-Kategorie zum Schwärzen an.
curl -X POST https://piiblur.com/api/v1/media/redact \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "[email protected]" \
-F "categories[]=heads" \
-F "categories[]=license_plates"
Die Antwort gibt ein öffentliches Medienobjekt mit dem Status queued zurück:
{
"id": "9f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"status": "queued",
"filename": "photo.jpg",
"media_type": "image",
"categories": ["heads", "license_plates"],
"redaction_method": "blur",
"file_size_bytes": 482391,
"duration_seconds": null,
"created_at": "2026-03-11T14:30:00+00:00",
"processed_at": null,
"failed_at": null
}
Geben Sie die Schwärzungsmethode - blur oder pixelation - pro Anfrage an:
curl -X POST https://piiblur.com/api/v1/media/redact \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "[email protected]" \
-F "categories[]=heads" \
-F "categories[]=documents" \
-F "redaction_method=pixelation"
Bilder werden in Sekundenschnelle verarbeitet. Die Videoverarbeitungszeit hängt von der Dauer und der Auflösung ab.
Jobstatus prüfen
Fragen Sie den Statusendpunkt ab, um den Abschluss zu überprüfen:
curl -X GET https://piiblur.com/api/v1/media/9f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c \
-H "Authorization: Bearer YOUR_API_KEY"
Ein abgeschlossener Job gibt ein download_url zurück:
{
"id": "9f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"status": "completed",
"filename": "photo.jpg",
"media_type": "image",
"categories": ["heads", "license_plates"],
"redaction_method": "blur",
"file_size_bytes": 482391,
"duration_seconds": null,
"created_at": "2026-03-11T14:30:00+00:00",
"processed_at": "2026-03-11T14:30:04+00:00",
"failed_at": null,
"download_url": "https://piiblur.com/api/v1/media/9f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/download"
}
Das Feld download_url wird erst angezeigt, nachdem die Verarbeitung abgeschlossen ist.
Geschwärzte Ausgabe wird heruntergeladen
Rufen Sie die geschwärzte Datei mit einer GET-Anfrage an die Download-URL ab:
curl -X GET https://piiblur.com/api/v1/media/9f1a2b3c-4d5e-6f7a-8b9c-0d1e2f3a4b5c/download \
-H "Authorization: Bearer YOUR_API_KEY" \
-o redacted_photo.jpg
Für Downloads ist Ihr API-Schlüssel erforderlich. Speichern Sie die geschwärzte Datei in Ihrem eigenen Speicher als Teil Ihrer Pipeline.
Webhooks statt Polling verwenden
Polling funktioniert bei einfachen Integrationen, Webhooks eignen sich jedoch besser für Produktionssysteme. Registrieren Sie einen Webhook-Endpunkt im Dashboard und PiiBlur postet an ihn, wenn ein Job abgeschlossen wird, fehlschlägt oder wenn die ursprüngliche Quelldatei gelöscht wird.
Konfigurieren Sie Webhook-Endpunkte im API-Bereich Ihres Dashboards. Webhooks finden auf Teamebene statt und werden nicht pro Upload-Anfrage übergeben.
Webhook-Nutzlasten umfassen eine Ereignis-ID, einen Zeitstempel, einen Ereignisnamen, eine Medien-ID, einen Status und ein verschachteltes media-Objekt, das dieselben öffentlichen Felder wie der Medienstatus-Endpunkt verwendet. Abgeschlossene redigierte Medien enthalten ein authentifiziertes media.download_url. Überprüfen Sie den X-PiiBlur-Signature-Header, um zu bestätigen, dass die Anfrage von PiiBlur stammt. Details zur Signaturüberprüfung finden Sie im API-Dokumentation.
Informationen zu einer Produktionsarchitektur mit Idempotenzschlüsseln, Ereignisdeduplizierung, Download-Workern und Wiederholungswarteschlangen finden Sie unter So erstellen Sie eine Webhook-basierte Redaktionspipeline.
Aufbau einer Batch-Verarbeitungspipeline
Die meisten Produktions-Workloads verarbeiten viele Dateien, nicht eine nach der anderen. Eine Batch-Pipeline übermittelt Jobs parallel und sammelt Ergebnisse über Webhooks.
Der Arbeitsablauf:
- Dateien in die Warteschlange stellen. Ihre Anwendung sammelt Dateien - von Benutzer-Uploads, einem Speicher-Bucket oder einem geplanten Scan - und stellt sie in eine Verarbeitungswarteschlange. 2.Jobs parallel senden. Jede Datei per POST an den Medienendpunkt senden. Die API akzeptiert gleichzeitige Anfragen innerhalb der Ratengrenzen Ihres Plans. 3.Empfangen Sie Webhook-Rückrufe. Nach Abschluss jedes Auftrags sendet PiiBlur das Ergebnis an Ihren Webhook-Endpunkt. 4.Geschwärzte Ausgabe speichern. Ihr Webhook-Handler lädt die geschwärzte Datei herunter und schreibt sie in den Speicher. 5.Behandeln Sie Fehler. Wenn ein Job fehlschlägt, verwenden Sie den Webhook-Status „Fehlgeschlagen“, um Wiederholungsversuche oder eine manuelle Überprüfung auszulösen.
Dieses Muster lässt sich auf jedes Volumen skalieren. Eine Pipeline, die 10.000 Bilder pro Tag verarbeitet, folgt der gleichen Logik wie eine, die 10 verarbeitet - nur die Parallelität und die Warteschlangenverwaltung unterscheiden sich.
Für Integrationen mit hohem Durchsatz finden Sie im API-Dokumentation Informationen zu Tariflimits und Antwortheadern pro Plan.
Auswählen von PII-Kategorien für Ihren Anwendungsfall
PiiBlur erkennt 13 PII-Kategorien: Köpfe, Nummernschilder, Bildschirme, Schrift, Straßenschilder, Ausweise, Reisepässe, Kreditkarten, Namensschilder, QR-Codes, Barcodes, Dokumente und Tätowierungen. Nicht jeder Anwendungsfall erfordert alle davon.
Wählen Sie Kategorien basierend auf Ihren Daten, Überprüfungskriterien und Ihrem Datenschutzprogramm aus: -Vom Benutzer hochgeladene Fotos- Köpfe und Dokumente haben normalerweise Priorität
- Bilder auf Straßenebene- Köpfe, Nummernschilder und Straßenschilder
- Flotten-Dashcam-Aufnahmen- Köpfe, Nummernschilder und Bildschirme
- Immobilienfotografie- Köpfe, Bildschirme und Namensschilder
- Filmmaterial von Gesundheitseinrichtungen- Köpfe, Ausweise, Namensschilder und Dokumente
Wenn Sie nur die Kategorien angeben, die Sie benötigen, sorgt dies für eine schnelle Verarbeitung und vermeidet eine übermäßige Schwärzung.
Bei große Batch-Workflows wirkt sich die Kategorieauswahl auch auf die Kosten aus - weniger Kategorien bedeuten eine schnellere Verarbeitung und eine geringere Rechenleistung pro Bild.
Fehlerbehandlung
Die API gibt Standard-HTTP-Statuscodes zurück. Behandeln Sie diese in Ihrer Integration:
- 401- ungültiger oder abgelaufener API-Schlüssel
- 409- Idempotenzschlüssel mit einer anderen Nutzlast wiederverwendet oder eine passende Anfrage ist noch in Bearbeitung -** 422**- Validierungsfehler (fehlende Datei, nicht unterstütztes Format, ungültige Kategorie oder Video länger als 10 Minuten)
- 429- Kontingent oder Ratenlimit überschritten; Zu den Ratenbegrenzungsantworten gehört
Retry-After - 500 - Serverfehler; Versuchen Sie es erneut mit exponentiellem Backoff
Alle JSON-Fehler verwenden den standardmäßigen { "error": ..., "request_id": ... }-Umschlag. Überprüfen Sie den Antwortstatus, bevor Sie von einem Erfolg ausgehen, und protokollieren Sie request_id mit dem Antworttext, um das Debuggen zu erleichtern.
Überprüfen Sie Gates
Nicht jede abgeschlossene Arbeit sollte direkt in die Veröffentlichung gelangen. Fügen Sie ein Überprüfungstor hinzu, wenn Medien für die Veröffentlichung, rechtliche Offenlegung, Gesundheitsfürsorge, Bildung, Strafverfolgung oder andere Arbeitsabläufe, an denen Kinder oder schutzbedürftige Personen beteiligt sind, bestimmt sind.
Für risikoärmere interne Arbeitsabläufe testen Sie abgeschlossene Ausgaben, anstatt alles zu überprüfen. Verfolgen Sie Fehler nach Quellentyp und Kategorie. Wenn Rezensenten wiederholt Tafeln in Nachtaufnahmen oder Bildschirmtext in Büro-Komplettlösungen finden, machen Sie dies zu einer Workflow-Regel und nicht zu einem Gedächtnistest des Rezensenten.
Verwenden Sie QA-Checkliste für automatisierte Redaktion als Ausgangspunkt für die Überprüfungsrichtlinie.
Preis- und Tarifbeschränkungen
Das kostenlose Kontingent von PiiBlur umfasst 100 Bilder und 5 Minuten Video pro Monat - genug, um Ihre Integration zu erstellen und zu testen. Bezahlte Pläne beginnen bei 49 $/Monat und können für großvolumige Operationen auf 499 $/Monat erweitert werden. Mit jeder Stufe erhöhen sich die Ratenlimits und monatlichen Kontingente.
Die vollständigen Plandetails finden Sie auf Preisseite.
Beginnen Sie mit dem Bau
Der schnellste Weg, die API zu evaluieren: Verarbeiten Sie einige Ihrer eigenen Bilder. Besorgen Sie sich einen API-Schlüssel aus dem Dashboard, führen Sie das obige cURL-Upload-Beispiel aus und überprüfen Sie die Ausgabe. Vernetzen Sie dann die Webhooks, erstellen Sie Ihre Batch-Warteschlange und stellen Sie sie bereit. Das API-Dokumentation deckt alle Endpunkte, Parameter und Antwortformate ab.