API
API
Merk og detekter filer med API-et til Markedfile. Tilgjengelig på planene Business og Enterprise.
API-nøkler
Eieren av et arbeidsområde Business eller Enterprise oppretter og trekker tilbake nøkler i innstillingene for arbeidsområdet. En nøkkel vises én gang. Markedfile lagrer en SHA-256-hash, et kort prefiks og navnet. Hemmeligheten lagres ikke.
En nøkkel hører til nøyaktig ett arbeidsområde. Den virker bare der, med grensene i planen for det arbeidsområdet. Personlige arbeidsområder har ingen nøkler. Et medlem som ikke er eier, kan ikke opprette eller trekke dem tilbake.
Hvis arbeidsområdet mister den aktive planen Business eller Enterprise, slutter alle nøkler å virke med en gang, også i de 30 dagene der eksisterende filer fortsatt kan detekteres i appen. Når du kommer tilbake til Business eller Enterprise, virker nøkler som ikke er trukket tilbake, igjen.
Autentisering
Send hemmeligheten i headeren Authorization som et Bearer-token. Disse rutene bruker ingen øktinformasjonskapsel. En nettleser på et annet nettsted avvises.
Revisjon
Oppretting, tilbakekalling, merking og deteksjon skriver en revisjonsrad som eieren av arbeidsområdet kan lese. Raden inneholder ikke filen.
Endepunkter
POST/api/v1/mark
Merker en fil og returnerer den merkede kopien. Kroppen er multipart/form-data.
Autentisering
Authorization: Bearer mf_…Send denne headeren. Det finnes ingen øktinformasjonskapsel. curl og andre serverklienter godtas. En nettleser på et annet nettsted avvises.
Parametere
| Navn | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
| file | file | Ja | Filen som merkes. Business og Enterprise godtar opptil 100 MB, 500 PDF-sider og video opptil 10 minutter. Opplastingsstørrelse, videolengde og antall PDF-sider følger planen for arbeidsområdet. |
| identifier | string | Ja | 1 til 32 tegn, uten kontrolltegn. Dette er etiketten du ser hvis denne kopien detekteres senere. Den skrives ikke inn i filen som lesbar tekst. |
Forespørsel
curl -X POST https://markedfile.com/api/v1/mark \
-H "Authorization: Bearer mf_…" \
-F "file=@contract.pdf" \
-F "identifier=northwind"Svar
{
"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 er de merkede bytene i base64. mime, name og kind beskriver nedlastingen. layers nevner lagene som ble brukt. Hvis planen ikke har en grense for aktive filer, er remaining antallet aktive filer etter denne merkingen. Hvis den har en grense, er remaining hvor mange nye merkinger som er igjen. Business og Enterprise har ingen grense for aktive filer. Sletting av en fil avslutter deteksjonen.
Feil
Teksten i feltet error i JSON-kroppen er på engelsk.
| Status | Beskrivelse |
|---|---|
| 400 | Filen er tom, eller kjennetegnet er tomt, har mer enn 32 tegn eller inneholder et kontrolltegn. |
| 401 | Nøkkelen mangler, er trukket tilbake eller er ukjent. JSON-kroppen inneholder "code": "api-key". |
| 403 | Arbeidsområdet har ikke lenger en aktiv plan Business eller Enterprise (kroppen inneholder "code": "enterprise"), eller nettleseren sendte en cross-site- eller same-site-forespørsel. |
| 413 | Filen er over opplastingsgrensen for planen, eller PDF-en har flere sider enn planen tillater. |
| 422 | Filen kunne ikke behandles. |
| 429 | Denne nøkkelen har merket mer enn 40 filer i det inneværende minuttet. |
Forespørselsgrense
40 forespørsler per minutt for denne nøkkelen. Telleren ligger i produktdatabasen og gjelder fortsatt etter en omstart.
POST/api/v1/detect
Kontrollerer en fil i arbeidsområdet til denne nøkkelen. Kroppen er multipart/form-data.
Autentisering
Authorization: Bearer mf_…Send denne headeren. Det finnes ingen øktinformasjonskapsel. curl og andre serverklienter godtas. En nettleser på et annet nettsted avvises.
Parametere
| Navn | Type | Obligatorisk | Beskrivelse |
|---|---|---|---|
| file | file | Ja | Filen som kontrolleres. Treffet søkes bare i arbeidsområdet til denne nøkkelen. En fil som er merket i et annet arbeidsområde, gjenkjennes ikke. Et aktivt arbeidsområde Business eller Enterprise kan også kontrollere en videofil. Skjermbildet av ett bilde kontrolleres som et bilde. |
Forespørsel
curl -X POST https://markedfile.com/api/v1/detect \
-H "Authorization: Bearer mf_…" \
-F "file=@leaked.pdf"Svar
{
"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 er kjennetegnet du satte da denne kopien ble merket, eller null hvis dette arbeidsområdet ikke har et treff. confidence er 99 % for en nøyaktig fil, eller når et autentisert merke stemmer med et annet merke. Et bare visuelt treff forblir lavere. layers nevner lagene, og hit er true på lagene som stemte. notes beskriver hva kontrollen gjorde. En slettet fil gjenkjennes ikke.
Feil
Teksten i feltet error i JSON-kroppen er på engelsk.
| Status | Beskrivelse |
|---|---|
| 400 | Filen er tom. |
| 401 | Nøkkelen mangler, er trukket tilbake eller er ukjent. JSON-kroppen inneholder "code": "api-key". |
| 403 | Arbeidsområdet har ikke lenger en aktiv plan Business eller Enterprise (kroppen inneholder "code": "enterprise"), eller nettleseren sendte en cross-site- eller same-site-forespørsel. |
| 413 | Filen er over opplastingsgrensen for planen, eller PDF-en har flere sider enn planen tillater. |
| 422 | Filen kunne ikke behandles. |
| 429 | Denne nøkkelen har kjørt mer enn 80 deteksjoner i det inneværende minuttet. |
Forespørselsgrense
80 forespørsler per minutt for denne nøkkelen. Telleren ligger i produktdatabasen og gjelder fortsatt etter en omstart.