API de procesamiento del lado del servidor de FormRead

Procesamiento de formularios del lado del servidor

La API del lado del servidor de FormRead te permite enviar una imagen de formulario escaneado y recibir resultados estructurados (OMR, OCR, BCR) directamente como JSON. Sin navegador, sin iframe, solo una simple solicitud HTTP de tu backend al nuestro.

• Envía una imagen y recibe resultados como JSON en una sola solicitud
• Admite OMR (detección de burbujas), OCR (extracción de texto) y BCR (lectura de códigos de barras/QR)
• La configuración del formulario se carga automáticamente desde el formulario que configuraste en el panel de control

Autenticación

Para usos empresariales, la API se puede usar generando un token de autenticación "Bearer".

Inicie sesión en el panel de FormRead, y acceda a la opción API Token:

Cree los tokens de API para permitir que los servicios de terceros se autentiquen con nuestra aplicación en su nombre:

Procesar una imagen de formulario

Envía una imagen de formulario escaneado para procesarla. El formulario debe estar configurado previamente con áreas de lectura (OMR, OCR, BCR) a través del panel de control o iframe. La API usa la configuración guardada del formulario para procesar la imagen.

Encabezados

Con carga de archivo:

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

Con URL de imagen:

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

Respuesta

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

Campos de respuesta

Opciones de entrada de imagen

Puedes proporcionar la imagen de tres maneras. Usa exactamente una:

Procesamiento por lotes

Para procesar múltiples imágenes del mismo formulario en una sola solicitud, pase una lista de URLs separadas por comas en el campo image_url. Los resultados se devuelven como un arreglo en el mismo orden.

Solicitud

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

Respuesta

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

Parámetros del lote

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

Límites

Una respuesta 429 se ve así:

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

Una solicitud por lotes cuenta como una llamada sin importar cuántas URLs contenga.

Tipos de áreas admitidos

Ejemplos de código

Aquí hay ejemplos completos en Python y JavaScript para procesar una imagen de formulario:

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

Preguntas frecuentes