curl -X POST https://api.bizmori.com/api/v3/orders/wtr-extract \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"idempotencyKey": "6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59",
"file": {
"fileName": "suspect.png",
"originalFile": {
"fileName": "campaign.png"
}
}
}'const response = await fetch(`https://api.bizmori.com/api/v3/orders/wtr-extract`, {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"idempotencyKey": "6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59",
"file": {
"fileName": "suspect.png",
"originalFile": {
"fileName": "campaign.png"
}
}
})
});
const { data } = await response.json();
import requests
response = requests.post(
f'https://api.bizmori.com/api/v3/orders/wtr-extract',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
json={
"idempotencyKey": "6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59",
"file": {
"fileName": "suspect.png",
"originalFile": {
"fileName": "campaign.png"
}
}
}
)
data = response.json()['data']
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bizmori.com/api/v3/orders/wtr-extract",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'idempotencyKey' => '6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59',
'file' => [
'fileName' => 'suspect.png',
'originalFile' => [
'fileName' => 'campaign.png'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bizmori.com/api/v3/orders/wtr-extract"
payload := strings.NewReader("{\n \"idempotencyKey\": \"6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59\",\n \"file\": {\n \"fileName\": \"suspect.png\",\n \"originalFile\": {\n \"fileName\": \"campaign.png\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bizmori.com/api/v3/orders/wtr-extract")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"idempotencyKey\": \"6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59\",\n \"file\": {\n \"fileName\": \"suspect.png\",\n \"originalFile\": {\n \"fileName\": \"campaign.png\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bizmori.com/api/v3/orders/wtr-extract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"idempotencyKey\": \"6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59\",\n \"file\": {\n \"fileName\": \"suspect.png\",\n \"originalFile\": {\n \"fileName\": \"campaign.png\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"orderId": "<string>",
"status": "pending",
"processingDelayed": true,
"files": [
{
"fileId": "<string>",
"uploadUrl": "<string>"
}
],
"outputs": [
{
"fileId": "<string>",
"inputFileId": "<string>",
"outputIndex": 1,
"watermarkText": "<string>",
"status": "pending",
"mediaKind": "image"
}
],
"result": {
"detectionStatus": "detected",
"reportSupported": true,
"watermarkText": "<string>"
},
"reports": [
{
"locale": "ko-KR",
"status": "queued"
}
],
"expiresAt": "2023-11-07T05:31:56Z"
}
}{
"code": "VALIDATION_FAILED"
}{
"code": "AUTH_NOT_AUTHENTICATED"
}{
"code": "WATERMARK_V2_CONFLICT"
}{
"code": "RATE_LIMIT_EXCEEDED"
}{
"code": "SERVER_INTERNAL_ERROR"
}{
"code": "WATERMARK_V2_UNAVAILABLE"
}watermark 抽出注文を作成
1 つのファイルから不可視 watermark を検査する注文を作成します。
- リクエストごとに元ファイルと検査するファイルを一緒に提出します
- 画像の元ファイルには
jpg,jpeg,png,webp,bmp,tif,tiffの検査ファイル、PDF の元ファイルには PDF・PNG・JPEG の検査ファイルを指定できます - BMP・TIFF の処理可能な範囲は watermark の埋め込みと同じです。処理できないファイルは注文が
failedではなくcompleteで終わり、detectionStatusがunsupportedになり、クレジットは返金されます - レスポンスの
files[]は 2 件です。files[0]が元ファイル、files[1]が検査ファイルで、それぞれuploadUrlへPUTでアップロードします - 2 つのファイルのアップロードが終わると処理が自動で始まります。注文あたり 1 クレジットを使用し、
unsupported・errorの結果は返金されます - 結果は
GET /api/v3/orders/{orderId}のresultで確認します
curl -X POST https://api.bizmori.com/api/v3/orders/wtr-extract \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"idempotencyKey": "6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59",
"file": {
"fileName": "suspect.png",
"originalFile": {
"fileName": "campaign.png"
}
}
}'const response = await fetch(`https://api.bizmori.com/api/v3/orders/wtr-extract`, {
method: 'POST',
headers: {
'Authorization': 'Bearer YOUR_API_KEY',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"idempotencyKey": "6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59",
"file": {
"fileName": "suspect.png",
"originalFile": {
"fileName": "campaign.png"
}
}
})
});
const { data } = await response.json();
import requests
response = requests.post(
f'https://api.bizmori.com/api/v3/orders/wtr-extract',
headers={'Authorization': 'Bearer YOUR_API_KEY'},
json={
"idempotencyKey": "6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59",
"file": {
"fileName": "suspect.png",
"originalFile": {
"fileName": "campaign.png"
}
}
}
)
data = response.json()['data']
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bizmori.com/api/v3/orders/wtr-extract",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'idempotencyKey' => '6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59',
'file' => [
'fileName' => 'suspect.png',
'originalFile' => [
'fileName' => 'campaign.png'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bizmori.com/api/v3/orders/wtr-extract"
payload := strings.NewReader("{\n \"idempotencyKey\": \"6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59\",\n \"file\": {\n \"fileName\": \"suspect.png\",\n \"originalFile\": {\n \"fileName\": \"campaign.png\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bizmori.com/api/v3/orders/wtr-extract")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"idempotencyKey\": \"6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59\",\n \"file\": {\n \"fileName\": \"suspect.png\",\n \"originalFile\": {\n \"fileName\": \"campaign.png\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bizmori.com/api/v3/orders/wtr-extract")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"idempotencyKey\": \"6c3b9f7e-2d41-4a8e-9b5f-0e1d2c3b4a59\",\n \"file\": {\n \"fileName\": \"suspect.png\",\n \"originalFile\": {\n \"fileName\": \"campaign.png\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"orderId": "<string>",
"status": "pending",
"processingDelayed": true,
"files": [
{
"fileId": "<string>",
"uploadUrl": "<string>"
}
],
"outputs": [
{
"fileId": "<string>",
"inputFileId": "<string>",
"outputIndex": 1,
"watermarkText": "<string>",
"status": "pending",
"mediaKind": "image"
}
],
"result": {
"detectionStatus": "detected",
"reportSupported": true,
"watermarkText": "<string>"
},
"reports": [
{
"locale": "ko-KR",
"status": "queued"
}
],
"expiresAt": "2023-11-07T05:31:56Z"
}
}{
"code": "VALIDATION_FAILED"
}{
"code": "AUTH_NOT_AUTHENTICATED"
}{
"code": "WATERMARK_V2_CONFLICT"
}{
"code": "RATE_LIMIT_EXCEEDED"
}{
"code": "SERVER_INTERNAL_ERROR"
}{
"code": "WATERMARK_V2_UNAVAILABLE"
}承認
外部クライアントアクセス用のBearer APIキー。本番キーは sk_ プレフィックスを使用し、テストキーは sk_test_ プレフィックスを使用して、処理やクレジット消費なしに注文ライフサイクルを検証します。
ボディ
冪等性キー。新しい注文ごとに新しい UUIDv4 を使い、同じリクエストを再試行するときだけ再利用します。同じキーは既存の注文を返し、同じキーで異なるリクエストボディを送ると 409 WATERMARK_V2_CONFLICT を返します。
255レスポンス
元ファイルと検査ファイルのアップロード URL とともに注文を作成
v3 API で作成した不可視 watermark 注文
Hide child attributes
Hide child attributes
注文 ID
注文の処理ステータス
pending- ファイルのアップロード待ちinProgress- 処理中complete- 処理完了。抽出注文はresultで結果を確認しますfailed- 処理失敗、または 12 時間以内にアップロードされなかったexpired- 保管期限を過ぎ、ファイルが削除された
pending, inProgress, complete, failed, expired 自動再試行をすべて使い切り、手動復旧を待っている場合は true。注文は inProgress のままです
リクエスト順の入力ファイル。抽出注文は元ファイル、検査ファイルの順です
埋め込み結果。watermark テキストごとに 1 件で、抽出注文では空の配列です
Hide child attributes
Hide child attributes
{inputFileId}-{連番} 形式の結果ファイル ID(outputs[].fileId)
この結果を作成した入力ファイル ID
入力ファイルの watermarks 内でのテキストの位置
x >= 0埋め込んだ watermark テキスト
この結果ファイルの処理ステータス
pending, queued, processing, completed, failed, retry_required image, pdf 抽出結果の概要。埋め込み注文と、結果が出る前は null で、以下のフィールドだけを含みます
Hide child attributes
Hide child attributes
detected- watermark を検出not_detected- 最後まで検査したが watermark なしinconclusive- 候補はあるが確信度の基準に満たず判定不可unsupported- 処理できない入力 (クレジット返金)error- 検出処理の失敗。watermark なしとは異なる (クレジット返金)
detected, not_detected, inconclusive, unsupported, error この結果からレポートを作成できるかどうか。PDF からキャプチャした画像は false
検出された watermark の埋め込みテキスト。detectionStatus が detected で、呼び出し元のアカウントが埋め込み、発行記録がちょうど 1 件のときだけ返します。
別のアカウントが埋め込んだ watermark など、それ以外は null です。
注文ファイルが削除される日時。以降のダウンロードとレポートは ORDER_EXPIRED を返します