API OCR - Documentación

La API OCR permite a los usuarios extraer texto de diferentes tipos de documentos como INE, Recibo de Luz, Recibo de Nómina y Acta Constitutiva. Esta API ofrece dos endpoints:

• /get: Realiza la operación OCR en el documento proporcionado.
• /get_status/{uuid}: Consulta el estado de una solicitud de OCR previamente realizada.

Endpoint: /get

Este endpoint permite enviar un documento para realizar la operación OCR.

Parámetros de entrada:

• api-key: Clave de API necesaria para autenticar la solicitud.
• tipo_documento: Tipo de documento a procesar. Valores posibles: doc_ine, cfe_mex, recibo_nomina_1, acta_const.
• documento: Archivo PDF del documento codificado en base64.
• webhook_url: URL del webhook al que se enviará el resultado del proceso OCR.

Parámetros de salida:

• jsonrpc: Versión del protocolo JSON-RPC utilizado, en este caso "2.0".
• id: Identificador de la solicitud, en este caso siempre será null.
• result: Objeto que contiene el UUID de la solicitud:
  • uuid: Identificador único de la solicitud.

Ejemplo de invocación con CURL:

curl -X POST "https://vortem.consulting/vor_ocr/get" \
  -H "Content-Type: application/json" \
  -H "api-key: YOUR_API_KEY" \
  -d '{
    "tipo_documento": "doc_ine",
    "documento": "BASE64_ENCODED_PDF",
    "webhook_url": "https://your-webhook-url.com"
  }'
    

Endpoint: /get_status/{uuid}

Este endpoint permite consultar el estado y el resultado de una solicitud de OCR previamente realizada utilizando el UUID proporcionado.

Parámetros de entrada:

• api-key: Clave de API necesaria para autenticar la solicitud.
• uuid: Identificador único de la solicitud de OCR que se desea consultar.

Parámetros de salida:

• tipo_documento: Tipo de documento procesado.
• estatus: Estado del proceso OCR. Valores posibles: pending, success, failed.
• ocr_output: Objeto con el resultado del proceso OCR en caso de éxito. La estructura de este objeto depende del tipo de documento procesado.

Ejemplo de invocación con CURL:

curl -X GET "https://vortem.consulting/vor_ocr/get_status/YOUR_UUID" \
  -H "Content-Type: text/html" \
  -H "api-key: YOUR_API_KEY"