API

Documentaci\u00f3n T\u00e9cnica del API

Visi\u00f3n general de la arquitectura de integraci\u00f3n para especialistas t\u00e9cnicos. Protocolo de interacci\u00f3n as\u00edncrono, especificaciones de formato de datos y mecanismos de fiabilidad.

Obtener Acceso Pol\u00edtica de Seguridad

Principios Arquitect\u00f3nicos

  • Procesamiento As\u00edncrono: uso del patr\u00f3n Polling (202 Accepted) para escenarios de alta carga.
  • Idempotencia: soporte del encabezado Idempotency-Key para garantizar el procesamiento correcto de reintentos.
  • Tipado Estricto: validaci\u00f3n de datos de entrada (JSON Schema) a nivel de API Gateway. Formato principal del payload: { "text": "..." }.
  • Rate Limiting: cuotas de solicitudes a nivel de organizaci\u00f3n (RPS/RPM) para la protecci\u00f3n de la infraestructura.
  • Pol\u00edtica Zero-Log: modo opcional sin almacenamiento persistente de datos (procesamiento en memoria + TTL).

Nota: el API est\u00e1 optimizado para el procesamiento de datos de texto. El procesamiento de archivos binarios (PDF, im\u00e1genes) requiere OCR previo en el lado del cliente o el uso de un endpoint especializado (disponible en la versi\u00f3n extendida).

Especificaci\u00f3n y Acceso

La documentaci\u00f3n t\u00e9cnica completa, incluyendo descripciones de endpoints, modelos de datos y c\u00f3digos de error, se proporciona a los socios tras la firma del acuerdo.

  • Autenticaci\u00f3n: autenticaci\u00f3n mediante API Key / Bearer Token.
  • Versionado: soporte de versionado del API para garantizar compatibilidad retroactiva.
  • Gesti\u00f3n de Errores: c\u00f3digos de error estandarizados y mensajes detallados para depuraci\u00f3n.
  • SDK y Ejemplos: ejemplos de integraci\u00f3n para lenguajes de programaci\u00f3n populares (Python, JavaScript/TypeScript, Go).

Para obtener acceso al API y la documentaci\u00f3n completa, por favor env\u00ede una solicitud.

Flujo de Trabajo

  1. Iniciar Procesamiento: Env\u00edo de una solicitud POST con el payload y encabezado Idempotency-Key.
  2. Confirmaci\u00f3n: Recepci\u00f3n de respuesta 202 Accepted con task_id.
  3. Sondeo: Consulta peri\u00f3dica del estado de la tarea por task_id (el intervalo recomendado y la estrategia de backoff se especifican en la documentaci\u00f3n).
  4. Obtener Resultado: Recepci\u00f3n del resultado de procesamiento cuando el estado es COMPLETED.

Como parte del proyecto piloto, los prompts y plantillas de generaci\u00f3n se configuran para sus procesos de negocio espec\u00edficos.

Consultar Integraci\u00f3n