Guía de Desarrollo de Interfaces de API Abiertas

Todas las solicitudes de interfaz deben incluir los siguientes parámetros de autenticación en la URL:

URL de solicitud: /Code.ashx?op=code&app=api&token=YOUR_TOKEN&type=0

Método de llamada: POST

Los parámetros se escriben uniformemente en la URL, y los datos de la imagen se pasan por el cuerpo POST (se soporta multiparte flujo de archivos, campo de formulario o texto plano).

2.1 Introduce la imagen para ser reconocido (elige una de tres)

2.2 Modo central y control del motor

2.3 Reglas de Formato y Diseño (Opcional)

Los siguientes parámetros pasan valores 1 Activa el procesamiento correspondiente, valor 0 No está encendido.
Si no hay una necesidad específica, se recomienda no transmitirlo y dejar que el sistema decida:

2.4 Descripción del valor de retorno (JSON)

La interfaz de reconocimiento devuelve un formato JSON estándar. El valor es null el campo se omite automáticamente.

Campos de nivel superior

result Subobjeto – Resultado de texto

result Subobjeto - datos 🗺️ de posicionamiento de coordenadas

Los siguientes campos contienen la posición precisa de cada bloque de texto en la imagen original, adecuada para escenarios como resaltar superposiciones, extracción de áreas, etc.

verticalText Estructura de objetos TextCellInfo

[
  {
    "words": "El contenido de texto que se reconoce",
    "trans": "Resultados de traducción (si los hay)",
    "pageIndex": 0,
    "location": {
      "left": 120.0,
      "top": 45.0,
      "width": 230.0,
      "height": 28.0
    }
  },
  ...
]

result Subobjeto - Descarga de archivo

files La estructura de objetos DownLoadInfo en la estructura de objetos DownLoadInfo

state Enumeración estatal

Ejemplo trasero

✅ Respuesta exitosa (con datos de coordenadas):

{
  "ocrType": 0,
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "processId": 3,
  "processName": "OCR-Node-01",
  "state": 2,
  "result": {
    "autoText": "Texto completo tras la fusión inteligente",
    "spiltText": "Texto original dividido por párrafos",
    "verticalText": "[{\"words\":\"Hola\",\"location\":{\"left\":10,\"top\":20,\"width\":80,\"height\":22}}]",
    "resultType": 0,
    "lang": "chi_sim"
  }
}

❌ Respuesta al error/límite:

{
  "ocrType": 0,
  "processName": "Consejos",
  "result": {
    "spiltText": "La cuota de API de hoy se ha agotado, por favor recárgate y sigue usándola！",
    "autoText": "La cuota de API de hoy se ha agotado, por favor recárgate y sigue usándola！"
  },
  "id": 1
}

URL de solicitud: /Code.ashx?op=idcode&app=api&token=YOUR_TOKEN

Método de llamada: POST

Función: Devuelta según la interfaz de reconocimiento id Consulta los resultados del procesamiento asincrónico. Cuando la interfaz de reconocimiento regresa state=0(pendiente), puedes usar esta interfaz para encuestar y obtener el resultado final.

Ejemplo trasero

✅ Respuesta exitosa:

[
  {
    "ocrType": 0,
    "id": "a1b2c3d4-...",
    "processName": "OCR-Node-01",
    "state": 2,
    "result": {
      "autoText": "Identifica el texto resultante",
      "spiltText": "Texto segmentado",
      "resultType": 0
    }
  }
]

❌ Respuesta fallida (ID no existe o el resultado ha expirado):

no

Devuelve texto plano no Indica que no se encontró ningún resultado para ese ID, que puede ser un ID El error o resultado ha expirado y se ha eliminado.

URL de solicitud: /Code.ashx?op=imgUpload&app=api&token=YOUR_TOKEN

Método de llamada: POST (multipart/form-data)

Función: Sube una imagen a la cama de imágenes gratuita y devuelve una URL de enlace directo accesible en la red pública. Es adecuado para situaciones en las que necesitas subir primero una imagen y luego usar la URL para llamar a la interfaz de reconocimiento.

Ejemplo trasero

✅ Respuesta exitosa:

https://cdn.example.com/uploads/abc123.jpg

❌ Respuesta fallida (archivo no subido ni excepción de subida):

no

Devuelve texto plano no Indica que el archivo no fue recibido o que se produjo una excepción durante el proceso de subida.

URL de solicitud: /Code.aspx?op=count&app=api&token=YOUR_TOKEN

Método de llamada: GET

A través de esta interfaz, puedes ver el número de veces que se ha usado el token hoy y la cuota restante.

Ejemplo trasero

✅ Respuesta exitosa:

{
  "Account": "api",
  "TodayCount": 52, // Usado hoy"LimitCount": 9948       // El número total de restos actuales
}

❌ Respuesta al fallo (token inválido o no transmitido):

{
  "Account": "api",
  "TodayCount": 0,
  "LimitCount": 0
}

Nota: Si el token es inválido, no se reportará ningún error, pero devolverá JSON con todos los valores de 0, dependiendo de si el LimitCount es sí o no 0 para juzgar la validez del token.