API REST de GroupDocs.Annotation Cloud para Java

El SDK de GroupDocs.Annotation Cloud para Java te ayuda a construir aplicaciones Java de anotación de documentos en la nube que funcionan sin necesidad de instalar ningún software de terceros. Es un contenedor alrededor de las APIs REST de GroupDocs.Annotation Cloud.

Características de Anotación de Documentos

• Agregar una o múltiples anotaciones a documentos en la nube.
• Agregar anotaciones directamente a documentos almacenados en la nube.
• Soporte para varios tipos de anotaciones, incluyendo texto, imágenes y formas.
• Personalizar propiedades de anotación como color, tamaño y posición.
• Anotar múltiples formatos de documentos como PDF, Word, Excel, PowerPoint e imágenes.

Características de Gestión de Documentos

• Renderizado de Documentos: Convertir documentos en formatos como PDF, imágenes o HTML para visualización o impresión.
• Vista Previa de Documentos: Generar representaciones en imagen de las páginas del documento para propósitos de vista previa.
• Eliminar Anotaciones: Borrar anotaciones específicas o eliminar todas las anotaciones de un documento.
• Extraer Anotaciones: Recuperar todas las anotaciones de un documento como una lista de objetos JSON.

Gestión de Archivos y Almacenamiento

• Trabajando con la API de Archivos: Subir, descargar, copiar, mover y eliminar archivos en almacenamiento en la nube.
• Trabajando con la API de Carpetas: Organizar y gestionar carpetas en almacenamiento en la nube (crear, mover, eliminar).
• Trabajando con la API de Almacenamiento: Acceder y gestionar recursos de almacenamiento en la nube, incluyendo la recuperación de detalles de almacenamiento e información de archivos.
• Obtener Formatos de Archivos Soportados: Recuperar una lista de formatos de archivos soportados para anotaciones.
• Información del Archivo: Obtener información detallada sobre archivos en la nube, como tamaño, formato y metadatos.

Información y Procesamiento de Documentos

• Obtener Información del Documento: Recuperar información detallada del documento, incluyendo metadatos, contenido de texto y anotaciones.
• Obtener Páginas: Acceder a la lista de páginas en un documento junto con detalles como tamaño y orientación.
• Información de Anotación: Acceder a información detallada sobre anotaciones, incluyendo tipo, posición y contenido.
• Opciones de Anotación: Configurar varias opciones de anotación, incluyendo selección de páginas, posición y estilo.
• Uso Avanzado: Utilizar características avanzadas para gestionar anotaciones, como agrupación y ordenamiento.

Tipos de Anotaciones Soportadas

• Anotación de Área: Resaltar y anotar una área rectangular específica dentro de

un documento en la nube.

• Anotación de Flecha: Dibujar una flecha para señalar contenido específico en la página del documento en la nube.
• Anotación de Distancia: Medir y anotar la distancia entre dos objetos o puntos en un documento en la nube.
• Anotación de Elipse: Usar una forma elíptica para resaltar y anotar contenido específico en un documento.
• Anotación de Imagen: Superponer una imagen como anotación sobre el contenido del documento.
• Anotación de Enlace: Agregar una anotación de hipervínculo que enlace a un recurso externo.
• Anotación de Punto: Colocar una nota en un punto específico dentro del documento para una anotación detallada.
• Anotación de Polilínea: Dibujar líneas libres o formas para anotar y resaltar contenido.
• Anotación de Redacción de Recursos: Redactar texto sensible cubriéndolo con un rectángulo negro.
• Anotación de Campo de Texto: Agregar un comentario de texto dentro de un marco coloreado como anotación.
• Anotación de Resaltado de Texto: Resaltar texto y agregar comentarios para llamar la atención sobre contenido específico.
• Anotación de Redacción de Texto: Ocultar texto seleccionado con un rectángulo negro para redacción.
• Anotación de Reemplazo de Texto: Reemplazar texto original con un nuevo fragmento a través de anotación.
• Anotación de Tachado de Texto: Marcar texto con una línea de tachado para indicar eliminación.
• Anotación de Subrayado de Texto: Subrayar y anotar texto para darle énfasis.
• Anotación de Marca de Agua: Agregar una anotación de marca de agua sobre el documento.
• Anotación de Línea Ondulada: Usar una línea ondulada para subrayar y llamar la atención sobre el texto.

Características Específicas de la API

• Agregar Anotaciones Directamente: Agregar anotaciones a documentos sin descargarlos.
• Ejemplos Públicos de API: Acceder a código de ejemplo y documentación para utilizar las características de la API.

Formatos de Documentos de Anotación en la Nube Soportados

• Microsoft Word®: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, TXT
• OpenOffice Writer®: ODT, OTT
• Microsoft Excel®: XLS, XLSX, XLSB
• Microsoft PowerPoint®: PPT, PPTX, PPSX
• OpenOffice Impress®: ODP, OTP
• Microsoft Visio®: VSD, VDX, VSS, VSDM
• Microsoft Outlook®: MSG, EML, EMLX
• AutoCAD®: CAD
• Imágenes: DJVU, JPEG, TIFF, BMP, GIF (imágenes estáticas sin animación)
• Imágenes Médicas: DICOM
• Markup: HTML, MHTML
• Formato de Diseño Fijo: PDF
• MetaArchivos: EMF, WMF

Requisitos

• Versión de Java: La construcción de la biblioteca del cliente de la API requiere Java 1.7+.
• Herramienta de Construcción: Maven es necesario para gestionar dependencias y construir el proyecto.

Prerrequisitos

• Cuenta de GroupDocs Cloud: Para utilizar el SDK de GroupDocs.Annotation Cloud para Java, necesitas registrar una cuenta con GroupDocs Cloud.
• ID de Cliente y Secreto de Cliente: Después de registrarte, necesitas buscar o crear tu ID de Cliente y Secreto de Cliente en el Panel de Control en la Nube.
• Cuota Gratis: GroupDocs Cloud ofrece una cuota gratis para nuevos usuarios. Para más detalles, deberías revisar los Precios de GroupDocs Cloud.

Instalar GroupDocs.Annotation-Cloud desde Maven

Para instalar el SDK de GroupDocs.Annotation Cloud para Java, necesitas agregar el repositorio de GroupDocs Cloud al archivo pom.xml de tu aplicación:

<repository>
    <id>repository.groupdocs.cloud</id>
    <name>repository.groupdocs.cloud</name>
    <url>https://releases.groupdocs.cloud/java/repo/</url>
</repository>

Instalar desde el Código Fuente

Para instalar la biblioteca del cliente de la API desde el código fuente, sigue estos pasos:

• Instalar en el Repositorio Maven Local: Para instalar la biblioteca en tu repositorio Maven local, simplemente ejecuta el siguiente comando en la terminal:

mvn clean install

• Desplegar en un Repositorio Maven Remoto: Si deseas desplegarlo en un repositorio Maven remoto, configura la configuración del repositorio y ejecuta el siguiente comando:

mvn clean deploy

Para más detalles sobre el despliegue en un repositorio remoto, consulta la Guía OSSRH.

Usuarios de Maven

Si eres un usuario de Maven, puedes agregar el SDK de GroupDocs.Annotation Cloud para Java como una dependencia en el archivo pom.xml de tu proyecto:

<dependency>
    <groupId>com.groupdocs</groupId>
    <artifactId>groupdocs-annotation-cloud</artifactId>
    <version>22.2</version>
    <type>pom</type>
</dependency>

Empezar

Para comenzar con el SDK de GroupDocs.Annotation Cloud para Java, sigue estos pasos:

1. Instalar SDK: Instala el SDK siguiendo los pasos descritos arriba (usando Maven o instalando desde código fuente).
2. Configuración: Configura el SDK utilizando tu ID de Cliente y Secreto de Cliente obtenidos desde el Panel de Control de GroupDocs Cloud.
3. Código de Ejemplo: Implementa código de ejemplo en tu aplicación para agregar anotaciones, extraer información del documento, o gestionar archivos y carpetas.
4. Documentación: Consulta las instrucciones de inicio rápido y la documentación de la API para ejemplos detallados de uso y más información.

Autorización y Autenticación

El SDK de GroupDocs.Annotation Cloud para Java utiliza OAuth 2.0 para autorización y autenticación. Se proporcionan los siguientes detalles:

• Tipo de Autorización: OAuth 2.0
• Flujo: Autorización basada en aplicaciones
• URL de Autorización: https://api.groupdocs.cloud/connect/token
• Duración del Token: 1 día (por defecto)

JWT

El SDK de GroupDocs.Annotation Cloud utiliza JSON Web Tokens (JWT) para un acceso seguro a la API:

• Tipo de Token: OAuth 2.0 JWT (JSON Web Token)
• URL de Autorización: Los tokens se generan usando el endpoint https://api.groupdocs.cloud/connect/token.
• Expiración del Token: La duración por defecto del token es de 1 día, asegurando un acceso seguro y limitado en el tiempo a la API.

Estos detalles proporcionan una guía completa para configurar y usar el SDK de GroupDocs.Annotation Cloud para Java, cubriendo los requisitos esenciales, pasos de instalación y configuraciones de seguridad.

A continuación se presentan dos fragmentos de código destacados extraídos del contenido proporcionado. Estos fragmentos muestran funcionalidades esenciales que serían atractivas para usuarios potenciales que buscan integrar capacidades de anotación en sus aplicaciones.

Código de Ejemplo en Java para Agregar una Anotación de Punto en la Nube

Este fragmento demuestra cómo agregar una anotación de punto a un documento usando el SDK de GroupDocs.Annotation Cloud para Java. Las anotaciones de puntos son útiles para marcar puntos específicos en un documento con comentarios o notas.

// Para ejemplos completos y archivos de datos, por favor visita https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java-samples
String MyAppKey = ""; // Obtener AppKey y AppSID desde https://dashboard.groupdocs.cloud
String MyAppSid = ""; // Obtener AppKey y AppSID desde https://dashboard.groupdocs.cloud

Configuration

 configuration = new Configuration(MyAppSid, MyAppKey);
AnnotateApi apiInstance = new AnnotateApi(configuration);

// Crear anotación/es.
AnnotationInfo[] annotations = new AnnotationInfo[1];
annotations[0] = new AnnotationInfo();

Point pt = new Point();
pt.setX(1.0);
pt.setY(1.0);
annotations[0].setAnnotationPosition(pt);

Rectangle r = new Rectangle();
r.setX(100.0);
r.setY(100.0);
r.setWidth(200.0);
r.setHeight(100.0);

annotations[0].setBox(r);
annotations[0].setPageNumber(0);
annotations[0].setType(TypeEnum.POINT);
annotations[0].setText("Esta es una anotación de punto");
annotations[0].setCreatorName("Anonym A.");

// Crear objeto de solicitud.
FileInfo fileInfo = new FileInfo();
fileInfo.setFilePath("Annotationdocs\\one-page.docx");

AnnotateOptions options = new AnnotateOptions();
options.setFileInfo(fileInfo);
options.setAnnotations(Arrays.asList(annotations));
options.setOutputPath("Output/one-page-annotated.docx");

AnnotateRequest request = new AnnotateRequest(options);

// Ejecutando método de la API.
AnnotationApiLink result = apiInstance.annotate(request);
System.out.println("AddPointAnnotation: Anotación de Punto agregada: " + result.getTitle());

Código de Ejemplo en Java para Agregar una Anotación de Resaltado de Texto en la Nube

Este fragmento de código muestra cómo agregar una anotación de resaltado de texto a un documento. Resaltar texto es una tarea común de anotación, especialmente en procesos de revisión, y este fragmento ilustra cómo se puede hacer de manera programática.

// Para ejemplos completos y archivos de datos, por favor visita https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java-samples
String MyAppKey = ""; // Obtener AppKey y AppSID desde https://dashboard.groupdocs.cloud
String MyAppSid = ""; // Obtener AppKey y AppSID desde https://dashboard.groupdocs.cloud

Configuration configuration = new Configuration(MyAppSid, MyAppKey);
AnnotateApi apiInstance = new AnnotateApi(configuration);

// Crear anotación/es.
AnnotationInfo[] annotations = new AnnotationInfo[1];
annotations[0] = new AnnotationInfo();

Rectangle r = new Rectangle();
r.setX(100.0);
r.setY(100.0);
r.setWidth(300.0);
r.setHeight(50.0);

annotations[0].setBox(r);
annotations[0].setPageNumber(0);
annotations[0].setType(TypeEnum.TEXT_HIGHLIGHT);
annotations[0].setText("Este texto está resaltado");
annotations[0].setCreatorName("Anonym A.");

// Crear objeto de solicitud.
FileInfo fileInfo = new FileInfo();
fileInfo.setFilePath("Annotationdocs\\sample.docx");

AnnotateOptions options = new AnnotateOptions();
options.setFileInfo(fileInfo);
options.setAnnotations(Arrays.asList(annotations));
options.setOutputPath("Output/sample-annotated.docx");

AnnotateRequest request = new AnnotateRequest(options);

// Ejecutando método de la API.
AnnotationApiLink result = apiInstance.annotate(request);
System.out.println("AddTextHighlightAnnotation: Anotación de Resaltado de Texto agregada: " + result.getTitle());