API

Oznacz plik

Oznacz plik w obszarze Business albo Enterprise i pobierz oznaczoną kopię.

POST`/api/v1/mark`

Oznacza plik i zwraca oznaczoną kopię. Treść to multipart/form-data.

Uwierzytelnianie

Authorization: Bearer mf_…

Wyślij ten nagłówek. Nie ma pliku cookie sesji. curl i inni klienci serwerowi są przyjmowani. Przeglądarka na innej stronie jest odrzucana.

Parametry

Nazwa	Typ	Wymagane	Opis
file	file	Tak	Plik do oznaczenia. Business i Enterprise przyjmują do 100 MB, 500 stron PDF i wideo do 10 minut. Rozmiar wgrywania, długość wideo i liczba stron PDF wynikają z planu obszaru.
identifier	string	Tak	1–32 znaki, bez znaków sterujących. To etykieta, którą zobaczysz, jeśli ta kopia zostanie później wykryta. Nie jest zapisywana w pliku jako czytelny tekst.

Żądanie

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

Odpowiedź

{
  "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 to oznaczone bajty w base64. mime, name i kind opisują pobranie. layers pokazuje użyte warstwy. Gdy plan nie ma limitu aktywnych plików, remaining to liczba aktywnych plików po tym oznaczeniu. Gdy limit jest, remaining to liczba pozostałych nowych oznaczeń. Business i Enterprise nie mają limitu aktywnych plików. Usunięcie pliku kończy wykrywanie.

Błędy

Tekst pola error w odpowiedzi JSON jest po angielsku.

Stan	Opis
400	Plik jest pusty, albo identyfikator jest pusty, dłuższy niż 32 znaki albo zawiera znak sterujący.
401	Brak klucza, klucz unieważniony albo nieznany. Odpowiedź JSON zawiera "code": "api-key".
403	Obszar nie ma już aktywnego planu Business albo Enterprise (odpowiedź zawiera "code": "enterprise"), albo przeglądarka wysłała żądanie cross-site albo same-site.
413	Plik przekracza limit wgrywania planu, albo PDF ma więcej stron, niż plan pozwala.
422	Pliku nie dało się przetworzyć.
429	Ten klucz oznaczył ponad 40 plików w bieżącej minucie.

Limit wywołań

40 żądań na minutę dla tego klucza. Licznik jest w bazie produktu i zostaje po restarcie.