API
Eine Datei erkennen
Prüfe eine Datei gegen die aktiven Markierungen eines Enterprise-Arbeitsbereichs.
POST/api/v1/detect
Prüft eine Datei im Arbeitsbereich dieses Schlüssels. Der Körper ist multipart/form-data.
Authentifizierung
Authorization: Bearer mf_…Schick diese Kopfzeile. Es gibt kein Sitzungscookie. curl und andere Server-Clients werden angenommen. Ein Browser auf einer anderen Website wird abgelehnt.
Parameter
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
| file | file | Ja | Die Datei, die du prüfen willst. Gesucht wird nur im Arbeitsbereich dieses Schlüssels. Eine Datei, die in einem anderen Arbeitsbereich markiert wurde, wird nicht aufgelöst. |
Anfrage
curl -X POST https://markedfile.com/api/v1/detect \
-H "Authorization: Bearer mf_…" \
-F "file=@leaked.pdf"Antwort
{
"id": "northwind",
"confidence": 0.9,
"layers": [
{
"name": "Opaque PDF fields",
"hit": true,
"detail": "1 authenticated field(s) recovered",
"screenshot": "No",
"crop": "No",
"reencode": "No"
}
],
"notes": [
"Confidence is a heuristic for validated layer matches, not a measured forensic probability."
]
}id ist die Kennung, die du vergeben hast, als diese Kopie markiert wurde, oder null, wenn dieser Arbeitsbereich keine Übereinstimmung hat. confidence ist eine Heuristik für die geprüften Schichten, keine gemessene Wahrscheinlichkeit. layers listet die Träger, und hit ist wahr bei denen, die gepasst haben. notes beschreibt, was die Prüfung getan hat. Eine gelöschte Datei wird nicht aufgelöst.
Fehler
Der Text im Feld error im JSON-Körper ist Englisch.
| Status | Beschreibung |
|---|---|
| 400 | Die Datei ist leer. |
| 401 | Der Schlüssel fehlt, ist widerrufen oder unbekannt. Der JSON-Körper enthält "code": "api-key". |
| 403 | Der Arbeitsbereich hat keinen aktiven Enterprise-Tarif mehr (der Körper enthält "code": "enterprise"), oder der Browser hat einen Cross-Site- oder Same-Site-Abruf gesendet. |
| 413 | Die Datei liegt über der Upload-Grenze des Tarifs, oder das PDF hat mehr Seiten, als der Tarif erlaubt. |
| 422 | Die Datei konnte nicht verarbeitet werden. |
| 429 | Dieser Schlüssel hat in der laufenden Minute mehr als 80 Erkennungen ausgeführt. |
Grenze
80 Anfragen pro Minute für diesen Schlüssel. Der Zähler liegt in der Produktdatenbank und übersteht einen Neustart.