API
Dosyayı işaretle
Business veya Enterprise çalışma alanında bir dosyayı işaretle ve işaretli kopyayı indir.
POST/api/v1/mark
Bir dosyayı işaretler ve işaretli kopyayı döndürür. Gövde multipart/form-data'dır.
Kimlik doğrulama
Authorization: Bearer mf_…Bu başlık satırını gönder. Oturum çerezi yoktur. curl ve diğer sunucu istemcileri kabul edilir. Başka bir sayfadaki tarayıcı reddedilir.
Parametreler
| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
| file | file | Evet | İşaretlenecek dosya. Business ve Enterprise 100 MB'a, 500 PDF sayfasına ve 10 dakikaya kadar videoya kadar kabul eder. Yükleme boyutu, video süresi ve PDF sayfa sayısı alanın planından gelir. |
| identifier | string | Evet | 1–32 karakter, kontrol karakteri yok. Bu kopya sonra tespit edilince göreceğin etikettir. Dosyaya okunabilir metin olarak yazılmaz. |
İstek
curl -X POST https://markedfile.com/api/v1/mark \
-H "Authorization: Bearer mf_…" \
-F "file=@contract.pdf" \
-F "identifier=northwind"Yanıt
{
"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, base64 içindeki işaretli baytlardır. mime, name ve kind indirmeyi anlatır. layers kullanılan katmanları gösterir. Planın aktif dosya limiti yoksa remaining bu işaretten sonraki aktif dosya sayısıdır. Limit varsa remaining kalan yeni işaret sayısıdır. Business ve Enterprise aktif dosya limiti koymaz. Dosyayı silmek tespiti bitirir.
Hatalar
JSON yanıtındaki error alanının metni İngilizcedir.
| Durum | Açıklama |
|---|---|
| 400 | Dosya boş ya da tanımlayıcı boş, 32 karakterden uzun veya bir kontrol karakteri içeriyor. |
| 401 | Anahtar yok, anahtar iptal edilmiş veya bilinmiyor. JSON yanıtı "code": "api-key" içerir. |
| 403 | Çalışma alanının artık aktif bir Business veya Enterprise planı yok (yanıt "code": "enterprise" içerir) ya da tarayıcı cross-site veya same-site bir istek gönderdi. |
| 413 | Dosya planın yükleme limitini aşıyor ya da PDF, planın izin verdiğinden fazla sayfa içeriyor. |
| 422 | Dosya işlenemedi. |
| 429 | Bu anahtar aynı dakika içinde 40 dosyadan fazla işaretledi. |
Çağrı limiti
Bu anahtar için dakikada 40 istek. Sayaç ürün veritabanındadır ve yeniden başlatmadan sonra kalır.