API

Tandai file

Tandai file di ruang kerja Business atau Enterprise dan unduh salinan yang ditandai.

POST/api/v1/mark

Menandai sebuah file dan mengembalikan salinan yang ditandai. Isi permintaan adalah multipart/form-data.

Autentikasi

Authorization: Bearer mf_…

Kirim baris header ini. Tidak ada cookie sesi. curl dan klien server lain diterima. Peramban dari halaman lain ditolak.

Parameter

NamaJenisWajibPenjelasan
filefileYaFile yang akan ditandai. Business dan Enterprise menerima hingga 100 MB, 500 halaman PDF, dan video hingga 10 menit. Ukuran unggah, durasi video, dan jumlah halaman PDF mengikuti paket ruang kerja.
identifierstringYa1–32 karakter, tanpa karakter kontrol. Ini label yang kamu lihat saat salinan ini nanti terdeteksi. Tidak ditulis ke file sebagai teks yang bisa dibaca.

Permintaan

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

Respons

{
  "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 adalah byte yang ditandai dalam base64. mime, name, dan kind menjelaskan unduhan. layers menunjukkan lapisan yang dipakai. Jika paket tidak membatasi file aktif, remaining adalah jumlah file aktif setelah tanda ini. Jika ada batas, remaining adalah sisa tanda baru. Business dan Enterprise tidak membatasi file aktif. Menghapus file mengakhiri deteksi.

Kesalahan

Teks pada kolom error di respons JSON berbahasa Inggris.

StatusPenjelasan
400File kosong, atau pengenal kosong, lebih dari 32 karakter, atau berisi karakter kontrol.
401Kunci tidak ada, kunci dicabut, atau tidak dikenal. Respons JSON berisi "code": "api-key".
403Ruang kerja tidak lagi punya paket Business atau Enterprise yang aktif (respons berisi "code": "enterprise") atau peramban mengirim permintaan cross-site atau same-site.
413File melebihi batas unggah paket, atau PDF berisi lebih banyak halaman daripada yang diizinkan paket.
422File tidak dapat diproses.
429Kunci ini menandai lebih dari 40 file dalam menit yang sama.

Batas panggilan

40 permintaan per menit untuk kunci ini. Penghitung ada di basis data produk dan tetap ada setelah mulai ulang.