API de traitement côté serveur de FormRead

Traitement de formulaires côté serveur

L'API côté serveur FormRead vous permet d'envoyer une image de formulaire numérisé et de recevoir des résultats structurés (OMR, OCR, BCR) directement en JSON. Pas de navigateur, pas d'iframe - juste une simple requête HTTP de votre backend au nôtre.

• Envoyez une image, recevez des résultats en JSON en une seule requête
• Prend en charge l'OMR (détection de bulles), l'OCR (extraction de texte) et le BCR (lecture de codes-barres/QR)
• La configuration du formulaire est chargée automatiquement à partir du formulaire que vous avez configuré dans le tableau de bord

Authentification

Pour les utilisations en entreprise, l'API peut être utilisée en générant un jeton d'authentification Bearer.

Connectez-vous au tableau de bord FormRead tableau de bord et accédez à l'option Token API:

Créez les jetons API pour permettre à des services tiers de s'authentifier auprès de notre application en votre nom:

Traiter une image de formulaire

Envoyez une image de formulaire numérisé à traiter. Le formulaire doit déjà être configuré avec des zones de lecture (OMR, OCR, BCR) via le tableau de bord ou l'iframe. L'API utilise la configuration enregistrée du formulaire pour traiter l'image.

En-têtes

Avec téléchargement de fichier :

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

Avec URL d'image :

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

Réponse

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

Champs de réponse

Options d'entrée d'image

Vous pouvez fournir l'image de trois manières. Utilisez exactement une :

Traitement par lots

Pour traiter plusieurs images du même formulaire en une seule requête, transmettez une liste d'URL séparées par des virgules dans le champ image_url. Les résultats sont renvoyés sous forme de tableau dans le même ordre.

Requête

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

Réponse

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

Paramètres de lot

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

Limites

Une réponse 429 ressemble à ceci :

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

Une requête par lot compte comme une appel, quel que soit le nombre d'URL qu'elle contient.

Types de zones pris en charge

Exemples de code

Voici des exemples complets en Python et JavaScript pour traiter une image de formulaire :

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

Questions fréquentes