API
ファイルを検出
Business または Enterprise ワークスペースの有効なマークに対してファイルを調べます。
POST/api/v1/detect
このキーのワークスペースに対してファイルを調べます。本文は multipart/form-data です。
認証
Authorization: Bearer mf_…このヘッダーを送ります。セッション Cookie はありません。curl と他のサーバークライアントは受け付けます。別のサイトのブラウザは拒否されます。
パラメーター
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| file | file | はい | 調べるファイルです。検索はこのキーのワークスペースだけです。別のワークスペースでマークしたファイルは解決しません。有効な Business または Enterprise ワークスペースは動画ファイルも調べられます。1 フレームのスクリーンショットは画像として調べます。 |
リクエスト
curl -X POST https://markedfile.com/api/v1/detect \
-H "Authorization: Bearer mf_…" \
-F "file=@leaked.pdf"レスポンス
{
"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 は、そのコピーをマークしたときに付けた識別子です。このワークスペースに一致がないときは null です。confidence は、ファイルが完全に一致するとき、または認証されたマークが別のマークと一致するとき 99% です。見た目だけの一致はそれより低くなります。layers は層を列挙し、一致した層の hit は true です。notes は調べた内容を説明します。削除したファイルは解決しません。
エラー
JSON 本文の error フィールドの文は英語です。
| 状態 | 説明 |
|---|---|
| 400 | ファイルが空です。 |
| 401 | キーがない、失効している、または不明です。JSON 本文に "code": "api-key" が含まれます。 |
| 403 | ワークスペースに有効な Business または Enterprise プランがなくなりました(本文に "code": "enterprise" が含まれます)。またはブラウザが cross-site か same-site のリクエストを送りました。 |
| 413 | ファイルがプランのアップロード上限を超えているか、PDF のページ数がプランの上限を超えています。 |
| 422 | ファイルを処理できませんでした。 |
| 429 | このキーは現在の 1 分間に 80 件を超える検出を実行しました。 |
制限
このキーは 1 分に 80 リクエストです。カウンターは製品のデータベースに保存され、再起動後も残ります。