FormRead सर्वर-साइड प्रोसेसिंग API

सर्वर-साइड फॉर्म प्रोसेसिंग

FormRead सर्वर-साइड API आपको एक स्कैन किए गए फॉर्म इमेज को भेजने और सीधे JSON के रूप में संरचित परिणाम (OMR, OCR, BCR) प्राप्त करने देता है। कोई ब्राउज़र नहीं, कोई iframe नहीं - बस आपके बैकएंड से हमारे बैकएंड तक एक सरल HTTP अनुरोध।

• एक इमेज भेजें, एकल अनुरोध में JSON के रूप में परिणाम प्राप्त करें
• OMR (बबल डिटेक्शन), OCR (टेक्स्ट एक्सट्रैक्शन), और BCR (बारकोड/QR रीडिंग) का समर्थन करता है
• फॉर्म कॉन्फ़िगरेशन डैशबोर्ड में आपके द्वारा सेट किए गए फॉर्म से स्वचालित रूप से लोड होता है

प्रमाणीकरण

एंटरप्राइज़ उपयोग के लिए, API का उपयोग Bearer Auth टोकन उत्पन्न करके किया जा सकता है।

FormRead डैशबोर्ड में लॉगिन करें और API टोकन विकल्प तक पहुंचें:

API टोकन बनाएं ताकि तृतीय-पक्ष सेवाएं आपकी ओर से हमारे एप्लिकेशन से प्रमाणित हो सकें:

फॉर्म इमेज प्रोसेस करें

प्रोसेस करने के लिए एक स्कैन किए गए फॉर्म इमेज को भेजें। फॉर्म को पहले से डैशबोर्ड या iframe के माध्यम से रीड एरिया (OMR, OCR, BCR) के साथ सेट किया जाना चाहिए। API इमेज को प्रोसेस करने के लिए सहेजे गए फॉर्म कॉन्फ़िगरेशन का उपयोग करता है।

Headers

फ़ाइल अपलोड के साथ:

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

Response

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

प्रतिक्रिया फ़ील्ड

इमेज इनपुट विकल्प

आप इमेज तीन तरीकों से प्रदान कर सकते हैं। बिल्कुल एक का उपयोग करें:

Batch Processing

To process multiple images of the same form in one request, pass a comma-separated list of URLs in the image_url field. Results are returned as an array in the same order.

Request

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

Response

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

Batch Parameters

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

Limits

A 429 response looks like this:

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

A batched request counts as one call regardless of how many URLs it contains.

समर्थित एरिया प्रकार

कोड उदाहरण

फॉर्म इमेज प्रोसेस करने के लिए 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' }

अक्सर पूछे जाने वाले प्रश्न