Saltar al contenido principal
Biblioteca Java para la API de DeepXL: detección de fraude, análisis de documentos y verificación de identidad.

​
Instalación

​
Maven

Añade la siguiente dependencia a tu pom.xml: 
<dependency>
    <groupId>ai.deepxl.sdk</groupId>
    <artifactId>deepxl</artifactId>
    <version>1.0.0</version>
</dependency>

​
Ejemplo

Crea una clave de API en el Panel de DeepXL (Configuración → Claves de API).
Trata tu clave de API como cualquier secreto de entorno. No la subas a un repositorio público ni la almacenes en texto plano.
import ai.deepxl.sdk.DeepXLClient;
import ai.deepxl.sdk.DeepXLError;
import com.google.gson.JsonObject;

DeepXLClient client = new DeepXLClient(System.getenv("DEEPXL_API_KEY"));

try {
    JsonObject detection = client.detectFile("document", "./file.pdf");
    JsonObject parsed = client.parseFile("light", "./id.pdf");
    JsonObject verification = client.verifyFiles("./id.jpg", "./selfie.jpg");
    System.out.println(detection.get("likelihood") + " " + parsed.get("documentType") + " " + verification.get("verified"));
} catch (DeepXLError e) {
    // Handle error
}

​
Métodos del cliente

​
Cuenta

  • checkUsage() – GET /v1/account. Devuelve UsageResponse (uso y límites por tipo de medio).

​
Modelos

  • getDetectionModels() – GET /v1/detection-models. Devuelve JsonArray de objetos de modelo.
  • getParsingModels() – GET /v1/parsing-models. Devuelve JsonArray de objetos de modelo.

​
Detección de fraude

  • detect(modelName, fileName, fileData [, tagsJson]) / detectFile(modelName, filePath [, tagsJson]) – POST /v1/detection. Modelos: document, object. Devuelve JsonObject.
  • getDetection(detectionId) – GET /v1/detection/. Devuelve JsonObject.
  • listDetections() / listDetections(params) – GET /v1/detection. Parámetros: Map con limit, offset, sortBy, direction, tagFilter. Devuelve JsonObject con totalCount, count, data.

​
Análisis de documentos

  • parse(modelName, fileName, fileData [, tagsJson]) / parseFile(modelName, filePath [, tagsJson]) – POST /v1/parse. Modelos: light, performance. Devuelve JsonObject.
  • getParse(parseId) – GET /v1/parse/. Devuelve JsonObject.
  • listParses() / listParses(params) – GET /v1/parse. Devuelve JsonObject con totalCount, count, data.

​
Verificación de identidad

  • verify(idFileName, idFileData, selfieFileName, selfieFileData [, tagsJson]) / verifyFiles(idFilePath, selfieFilePath [, tagsJson]) – POST /v1/verification. Devuelve JsonObject.
  • getVerification(verificationId) – GET /v1/verification/. Devuelve JsonObject.
  • listVerifications() / listVerifications(params) – GET /v1/verification. Devuelve JsonObject con totalCount, count, data.

​
Recuperación de archivos

  • getFile(fileName) – GET /v1/files/. Devuelve byte[]. Usa el nombre del archivo del arreglo files en cualquier respuesta de análisis.

​
Errores

Todos los métodos lanzan DeepXLError para errores de la API (clave inválida, solicitud incorrecta, límite de uso, no encontrado, etc.).