API

Zjisti soubor

Zkontroluj soubor proti aktivním označením pracovního prostoru Business nebo Enterprise.

POST/api/v1/detect

Zkontroluje soubor v pracovním prostoru tohohle klíče. Tělo je multipart/form-data.

Ověření

Authorization: Bearer mf_…

Pošli tenhle hlavičkový řádek. Není tu soubor cookie relace. curl a další serveroví klienti se přijímají. Prohlížeč na jiné stránce se odmítá.

Parametry

NázevTypPovinnéPopis
filefileAnoSoubor ke kontrole. Zásah se hledá jen v prostoru tohohle klíče. Soubor označený v jiném prostoru se nepozná. Aktivní prostor Business nebo Enterprise umí zkontrolovat i videosoubor. Snímek jednoho snímku se kontroluje jako obrázek.

Požadavek

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

Odpověď

{
  "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 je identifikátor, který jsi zadal, když se kopie označovala, nebo null, když tenhle prostor nemá zásah. confidence je 99 % u přesného souboru nebo když se ověřená značka shoduje s jinou značkou. Samotný vizuální zásah zůstává níž. layers ukazuje vrstvy a hit je true u těch, které se shodují. notes popisuje, co kontrola udělala. Smazaný soubor se nepozná.

Chyby

Text pole error v odpovědi JSON je anglicky.

StavPopis
400Soubor je prázdný.
401Chybí klíč, klíč je zneplatněný, nebo je neznámý. Odpověď JSON obsahuje "code": "api-key".
403Pracovní prostor už nemá aktivní tarif Business nebo Enterprise (odpověď obsahuje "code": "enterprise"), nebo prohlížeč poslal požadavek cross-site nebo same-site.
413Soubor překračuje limit nahrávání tarifu, nebo má PDF víc stran, než tarif dovoluje.
422Soubor se nepodařilo zpracovat.
429Tenhle klíč provedl víc než 80 detekcí v běžné minutě.

Limit volání

80 požadavků za minutu pro tenhle klíč. Počítadlo je v databázi produktu a zůstane po restartu.