API integration

Procesar imágenes desde tu propio sistema vía REST API.

API Key

1. Configuración → Cuenta → API Keys.
2. Click en Generar nueva clave.
3. Copiá el token (solo se muestra una vez — guardalo seguro).

Endpoint

POST https://api.hijarvis.app/ocr/process

Headers

Authorization: Bearer TU_API_KEY
Content-Type: multipart/form-data

Payload

Campo	Tipo	Requerido	Descripción
template_id	string	sí	ID del template a usar (lo ves en el detalle del template)
image	file	sí	Archivo JPG / PNG / WEBP / PDF
external_id	string	no	ID propio para referenciar el resultado después
webhook_url	string	no	Si lo definís, Hijarvis hace POST con el resultado al terminar

Ejemplo cURL

curl -X POST https://api.hijarvis.app/ocr/process \
  -H "Authorization: Bearer hjv_live_abc123" \
  -F "template_id=tmpl_factura_v2" \
  -F "image=@/ruta/factura.jpg" \
  -F "external_id=factura-2025-001"

Response

{
  "id": "ocr_xyz789",
  "status": "success",
  "template_id": "tmpl_factura_v2",
  "external_id": "factura-2025-001",
  "data": {
    "numero_factura": "F001-1234",
    "fecha_emision": "2025-04-28",
    "ruc_emisor": "20123456789",
    "total": 450.00
  },
  "confidence": 0.96,
  "processed_at": "2025-04-28T14:23:11Z"
}

Webhooks

Si pasaste webhook_url, Hijarvis envía un POST cuando termina:

{
  "event": "ocr.processed",
  "ocr_id": "ocr_xyz789",
  "external_id": "factura-2025-001",
  "status": "success",
  "data": { ... }
}

Tu endpoint debe responder 200 OK en menos de 5 segundos. Si falla, Hijarvis reintenta 3 veces con backoff exponencial.

Rate limits

• 100 requests/minuto por API key
• 1.000 requests/hora
• Tamaño máximo por imagen: 10MB

Si superás los límites recibís un 429 Too Many Requests con header Retry-After.