API

Een bestand markeren

Markeer een bestand in een werkruimte Business of Enterprise en download de gemarkeerde kopie.

POST`/api/v1/mark`

Markeert een bestand en geeft de gemarkeerde kopie terug. 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 gemarkeerd. Business en Enterprise accepteren tot 100 MB, 500 PDF-pagina's en video tot 10 minuten. De uploadgrootte, de videoduur en het aantal PDF-pagina's volgen het plan van de werkruimte.
identifier	string	Ja	1 tot 32 tekens, zonder stuurtekens. Dit is het label dat je ziet als deze kopie later wordt gedetecteerd. Het wordt niet als leesbare tekst in het bestand geschreven.

Verzoek

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

Antwoord

{
  "file": "JVBERi0xLjQK…",
  "mime": "application/pdf",
  "name": "contract.pdf",
  "kind": "pdf",
  "layers": [
    {
      "name": "Metadata",
      "detail": "Authenticated workspace reference; the identifier stays on the server",
      "screenshot": "No",
      "crop": "No",
      "reencode": "No"
    }
  ],
  "remaining": 1
}

file zijn de gemarkeerde bytes in base64. mime, name en kind beschrijven de download. layers noemt de lagen die zijn toegepast. Als het plan geen limiet op actieve bestanden heeft, is remaining het aantal actieve bestanden na deze markering. Als er wel een limiet is, is remaining hoeveel nieuwe markeringen er nog over zijn. Business en Enterprise hebben geen limiet op actieve bestanden. Het verwijderen van een bestand beëindigt de detectie.

Fouten

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

Status	Beschrijving
400	Het bestand is leeg, of het kenmerk is leeg, heeft meer dan 32 tekens of bevat een stuurteken.
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 40 bestanden gemarkeerd in de huidige minuut.

Verzoeklimiet

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