API

Een bestand detecteren

Controleer een bestand tegen de actieve markeringen van een werkruimte Business of Enterprise.

POST`/api/v1/detect`

Controleert een bestand in de werkruimte van deze sleutel. De body is multipart/form-data.

Authenticatie

Authorization: Bearer mf_…

Stuur deze header. Er is geen sessiecookie. curl en andere serverclients worden geaccepteerd. Een browser op een andere site wordt geweigerd.

Parameters

Naam	Type	Verplicht	Beschrijving
file	file	Ja	Het bestand dat wordt gecontroleerd. De overeenkomst wordt alleen in de werkruimte van deze sleutel gezocht. Een bestand dat in een andere werkruimte is gemarkeerd, wordt niet herkend. Een actieve werkruimte Business of Enterprise kan ook een videobestand controleren. De schermafbeelding van één beeld wordt als afbeelding gecontroleerd.

Verzoek

curl -X POST https://markedfile.com/api/v1/detect \
  -H "Authorization: Bearer mf_…" \
  -F "file=@leaked.pdf"

Antwoord

{
  "id": "northwind",
  "confidence": 0.95,
  "layers": [
    {
      "name": "Metadata",
      "hit": true,
      "detail": "Authenticated metadata matched this workspace",
      "screenshot": "No",
      "crop": "No",
      "reencode": "No"
    }
  ],
  "notes": [
    "Confidence is 99% for an exact file or when an authenticated mark agrees with another mark. A visual match alone stays lower, and weak bit agreement stays far from a high score."
  ]
}

id is het kenmerk dat je instelde toen deze kopie werd gemarkeerd, of null als deze werkruimte geen overeenkomst heeft. confidence is 99% voor een exact bestand of wanneer een geauthenticeerde markering met een andere markering overeenkomt. Een alleen visuele overeenkomst blijft lager. layers noemt de lagen, en hit is true bij de lagen die overeenkwamen. notes beschrijft wat de controle deed. Een verwijderd bestand wordt niet herkend.

Fouten

De tekst van het veld error in de JSON-body is in het Engels.

Status	Beschrijving
400	Het bestand is leeg.
401	De sleutel ontbreekt, is ingetrokken of is onbekend. De JSON-body bevat "code": "api-key".
403	De werkruimte heeft geen actief plan Business of Enterprise meer (de body bevat "code": "enterprise"), of de browser stuurde een cross-site- of same-site-verzoek.
413	Het bestand gaat over de uploadlimiet van het plan, of de PDF heeft meer pagina's dan het plan toestaat.
422	Het bestand kon niet worden verwerkt.
429	Deze sleutel heeft meer dan 80 detecties gedaan in de huidige minuut.

Verzoeklimiet

80 verzoeken per minuut voor deze sleutel. De teller staat in de productdatabase en blijft gelden na een herstart.