API

Đánh dấu tệp

Đánh dấu tệp trong không gian làm việc Business hoặc Enterprise và tải xuống bản sao đã đánh dấu.

POST/api/v1/mark

Đánh dấu một tệp và trả về bản sao đã đánh dấu. Nội dung yêu cầu là multipart/form-data.

Xác thực

Authorization: Bearer mf_…

Gửi dòng header này. Không có cookie phiên. curl và máy khách máy chủ khác được chấp nhận. Trình duyệt từ trang khác bị từ chối.

Tham số

TênLoạiBắt buộcGiải thích
filefileCóTệp sẽ đánh dấu. Business nhận tối đa 100 MB, 500 trang PDF, và video tối đa 10 phút. Ở Enterprise, kích thước tệp, số trang PDF, độ dài video và kích thước tệp video là Tùy chỉnh. Kích thước tải lên, thời lượng video, và số trang PDF theo gói của không gian làm việc.
identifierstringCó1–32 ký tự, không có ký tự điều khiển. Đây là nhãn bạn thấy khi bản sao này sau đó được phát hiện. Không được ghi vào tệp dưới dạng văn bản có thể đọc.

Yêu cầu

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

Phản hồi

{
  "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 là byte đã đánh dấu ở dạng base64. mime, name, và kind mô tả bản tải xuống. layers cho thấy lớp được dùng. Nếu gói không giới hạn tệp đang hoạt động, remaining là số tệp đang hoạt động sau dấu này. Nếu có giới hạn, remaining là số dấu mới còn lại. Business và Enterprise không giới hạn tệp đang hoạt động. Xóa tệp kết thúc phát hiện.

Lỗi

Văn bản ở cột error trong phản hồi JSON là tiếng Anh.

Trạng tháiGiải thích
400Tệp trống, hoặc mã định danh trống, dài hơn 32 ký tự, hoặc chứa ký tự điều khiển.
401Khóa không có, khóa đã thu hồi, hoặc không được nhận ra. Phản hồi JSON chứa "code": "api-key".
403Không gian làm việc không còn gói Business hoặc Enterprise đang hoạt động (phản hồi chứa "code": "enterprise") hoặc trình duyệt gửi yêu cầu cross-site hoặc same-site.
413Tệp vượt giới hạn tải lên của gói, hoặc PDF có nhiều trang hơn mức gói cho phép.
422Tệp không thể xử lý.
503Máy chủ đang bận, hoặc việc đánh dấu tạm dừng để bảo trì.
429Khóa này đánh dấu hơn 40 tệp trong cùng một phút.

Giới hạn lệnh gọi

40 yêu cầu mỗi phút cho khóa này. Bộ đếm nằm trong cơ sở dữ liệu sản phẩm và vẫn còn sau khi khởi động lại.