FormRead Sunucu Tarafı İşleme API'si

Sunucu Tarafı Form İşleme

FormRead Sunucu Tarafı API, taranmış bir form görüntüsü göndermenize ve yapılandırılmış sonuçları (OMR, OCR, BCR) doğrudan JSON olarak almanıza olanak tanır. Tarayıcı yok, iframe yok - sadece arka ucunuzdan bizimkine basit bir HTTP isteği.

• Bir görüntü gönderin, sonuçları tek bir istekte JSON olarak geri alın
• OMR (baloncuk algılama), OCR (metin çıkarma) ve BCR (barkod/QR okuma) destekler
• Form yapılandırması, kontrol panelinde ayarladığınız formdan otomatik olarak yüklenir

Kimlik Doğrulama

Kurumsal kullanımlar için API, bir Bearer Auth jetonu oluşturularak kullanılabilir.

FormRead pano paneline giriş yapın ve API Token seçeneğine erişin:

Üçüncü taraf hizmetlerin sizin adınıza uygulamamızla kimlik doğrulaması yapabilmesi için API jetonlarını oluşturun:

Form Görüntüsünü İşleme

İşlenmek üzere taranmış bir form görüntüsü gönderin. Formun, kontrol paneli veya iframe aracılığıyla okuma alanları (OMR, OCR, BCR) ile önceden ayarlanmış olması gerekir. API, görüntüyü işlemek için kayıtlı form yapılandırmasını kullanır.

Üstbilgiler

Dosya yükleme ile:

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"'

Görüntü URL'si ile:

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"}'

Yanıt

{
  "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
}

Yanıt Alanları

Görüntü Giriş Seçenekleri

Görüntüyü üç şekilde sağlayabilirsiniz. Tam olarak birini kullanın:

Toplu İşleme

Aynı formun birden çok görüntüsünü tek bir istekte işlemek için image_url alanında virgülle ayrılmış bir URL listesi iletin. Sonuçlar aynı sırada bir dizi olarak döndürülür.

İstek

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"}'

Yanıt

{
  "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
}

Toplu İşlem Parametreleri

omr_details ile toplu işlem

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
  }'

Sınırlar

Bir 429 yanıtı şöyle görünür:

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

Toplu bir istek, içerdiği URL sayısından bağımsız olarak bir çağrı olarak sayılır.

Desteklenen Alan Türleri

Kod Örnekleri

Bir form görüntüsünü işlemek için Python ve JavaScript ile tam örnekler:

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' }

Sıkça Sorulan Sorular