FormReadサーバーサイド処理API

サーバーサイドフォーム処理

FormReadサーバーサイドAPIを使用すると、スキャンしたフォーム画像を送信し、構造化された結果（OMR、OCR、BCR）を直接JSONとして受け取ることができます。ブラウザもiframeも不要で、バックエンドから当社へシンプルなHTTPリクエストを送るだけです。

• 画像を送信し、1回のリクエストで結果をJSONとして受け取ります
• OMR（バブル検出）、OCR（テキスト抽出）、BCR（バーコード/QR読み取り）に対応
• フォーム設定は、ダッシュボードで設定したフォームから自動的に読み込まれます

認証

エンタープライズ用途では、Bearer認証トークンを生成してAPIを使用できます。

FormRead ダッシュボードにログインし、APIトークンオプションにアクセスします：

サードパーティサービスがあなたの代わりに当社のアプリケーションで認証できるように、APIトークンを作成します：

フォーム画像の処理

処理するスキャン済みフォーム画像を送信します。フォームには、ダッシュボードまたはiframeを介して、読み取り領域（OMR、OCR、BCR）がすでに設定されている必要があります。APIは保存されたフォーム設定を使用して画像を処理します。

ヘッダー

ファイルアップロードを使用:

curl --location 'https://formread.org/api/forms/123/process' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --form 'image=@"/path/to/scanned-form.jpg"'

画像URLを使用:

curl --location 'https://formread.org/api/forms/123/process' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"image_url": "https://example.com/scanned-form.jpg"}'

回答

{
  "success": true,
  "results": {
    "OMR-0-0": "A",
    "OMR-0-1": "C",
    "OMR-0-2": "B,D",
    "OCR-1": "John Smith",
    "BCR-2": "1234567890"
  },
  "omr_details": {
    "OMR-0": {
      "questions": [
        [
          {"left": 0.12, "top": 0.22, "width": 0.02, "height": 0.02, "blackPixelsRatio": 0.72},
          {"left": 0.15, "top": 0.22, "width": 0.02, "height": 0.02, "blackPixelsRatio": 0.15}
        ]
      ]
    }
  },
  "anchor_error": false,
  "processing_time_ms": 450
}

レスポンスフィールド

画像入力オプション

画像は 3 つの方法で指定できます。必ず 1 つのみ使用してください。

バッチ処理

1つのリクエストで同じフォームの複数の画像を処理するには、image_urlフィールドにカンマ区切りのURLリストを渡します。結果は同じ順序で配列として返されます。

リクエスト

curl --location 'https://formread.org/api/forms/123/process' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"image_url": "https://example.com/a.jpg,https://example.com/b.jpg,https://example.com/c.jpg"}'

回答

{
  "results": [
    {
      "id": "0",
      "image_url": "https://example.com/a.jpg",
      "success": true,
      "results": { "OMR-0-0": "A", "OCR-1": "John Smith" },
      "anchor_error": false,
      "processing_time_ms": 430
    },
    {
      "id": "1",
      "image_url": "https://example.com/b.jpg",
      "success": true,
      "results": { "OMR-0-0": "B", "OCR-1": "Jane Doe" }
    },
    {
      "id": "2",
      "image_url": "https://example.com/c.jpg",
      "success": false,
      "error": "Failed to fetch image from URL: 404"
    }
  ],
  "total": 3
}

バッチパラメータ

omr_details付きバッチ

curl --location 'https://formread.org/api/forms/123/process' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "image_url": "https://example.com/a.jpg,https://example.com/b.jpg",
    "details": true
  }'

制限

429レスポンスは次のようになります：

{
  "message": "Too Many Attempts."
}

バッチリクエストは、含まれるURLの数にかかわらず1回の呼び出しとしてカウントされます。

サポートされている領域タイプ

コード例

フォーム画像を処理するための Python と JavaScript の完全な例を次に示します。

Python

import requests

API_URL = "https://formread.org/api/forms/{form_id}/process"
TOKEN = "YOUR_API_TOKEN"

with open("scanned-form.jpg", "rb") as f:
    response = requests.post(
        API_URL.format(form_id=123),
        headers={
            "Accept": "application/json",
            "Authorization": f"Bearer {TOKEN}",
        },
        files={"image": f},
    )

data = response.json()
print(data["results"])
# {"OMR-0-0": "A", "OMR-0-1": "C", "OCR-1": "John Smith"}

Node.js

const FormData = require('form-data');
const fs = require('fs');
const axios = require('axios');

const form = new FormData();
form.append('image', fs.createReadStream('scanned-form.jpg'));

const response = await axios.post(
  'https://formread.org/api/forms/123/process',
  form,
  {
    headers: {
      ...form.getHeaders(),
      'Accept': 'application/json',
      'Authorization': 'Bearer YOUR_API_TOKEN',
    },
  }
);

console.log(response.data.results);
// { 'OMR-0-0': 'A', 'OMR-0-1': 'C', 'OCR-1': 'John Smith' }

よくある質問