Документ Аннотатор Java Облачный REST API

GroupDocs.Annotation Cloud SDK для Java помогает создавать облачные Java-приложения для аннотирования документов, работающие без установки стороннего ПО. Это оболочка вокруг GroupDocs.Annotation Cloud REST APIs.

Функции аннотирования документов

• Добавление одной или нескольких аннотаций к облачным документам.
• Добавление аннотаций непосредственно в документы, хранящиеся в облаке.
• Поддержка различных типов аннотаций, включая текст, изображения и фигуры.
• Настройка свойств аннотаций, таких как цвет, размер и позиция.
• Аннотирование множества форматов документов, таких как PDF, Word, Excel, PowerPoint, и изображения.

Функции управления документами

• Отрисовка документов: Конвертация документов в форматы, такие как PDF, изображения или HTML для просмотра или печати.
• Предварительный просмотр документа: Генерация изображений страниц документа для предварительного просмотра.
• Удаление аннотаций: Удаление конкретных аннотаций или всех аннотаций из документа.
• Извлечение аннотаций: Извлечение всех аннотаций из документа в виде списка объектов JSON.

Управление файлами и хранилищем

• Работа с файловым API: Загрузка, скачивание, копирование, перемещение и удаление файлов в облачном хранилище.
• Работа с API папок: Организация и управление папками в облачном хранилище (создание, перемещение, удаление).
• Работа с API хранилища: Доступ и управление ресурсами облачного хранилища, включая получение информации о хранилище и файлах.
• Получить поддерживаемые форматы файлов: Получение списка поддерживаемых форматов файлов для аннотаций.
• Информация о файле: Получение детальной информации о файлах в облаке, такой как размер, формат и метаданные.

Информация о документе и обработка

• Получение информации о документе: Получение подробной информации о документе, включая метаданные, текстовое содержимое и аннотации.
• Получить страницы: Доступ к списку страниц документа с деталями, такими как размер и ориентация.
• Информация об аннотациях: Доступ к детальной информации об аннотациях, включая тип, положение и содержимое.
• Опции аннотаций: Настройка различных опций аннотаций, включая выбор страниц, положение и стилизацию.
• Продвинутое использование: Использование продвинутых функций для управления аннотациями, таких как групп

ировка и упорядочивание.

Поддерживаемые типы аннотаций

• Аннотация области: Выделение и аннотирование конкретной прямоугольной области внутри облачного документа.
• Аннотация стрелки: Рисование стрелки для указания на конкретное содержимое на странице облачного документа.
• Аннотация расстояния: Измерение и аннотирование расстояния между двумя объектами или точками в облачном документе.
• Аннотация эллипса: Использование эллиптической формы для выделения и аннотирования конкретного содержимого в документе.
• Аннотация изображения: Наложение изображения в виде аннотации поверх содержимого документа.
• Аннотация ссылки: Добавление аннотации-ссылки, которая связывается с внешним ресурсом.
• Аннотация точки: Размещение заметки в конкретной точке внутри документа для детального аннотирования.
• Аннотация полилинии: Рисование произвольных линий или фигур для аннотирования и выделения содержимого.
• Аннотация редактирования ресурсов: Редактирование конфиденциального текста, закрывая его черным прямоугольником.
• Аннотация текстового поля: Добавление текстового комментария в цветной рамке в виде аннотации.
• Аннотация подсветки текста: Подсветка текста и добавление комментариев для привлечения внимания к конкретному содержимому.
• Аннотация редактирования текста: Скрытие выбранного текста черным прямоугольником для редактирования.
• Аннотация замены текста: Замена исходного текста на новый фрагмент через аннотацию.
• Аннотация зачёркивания текста: Зачеркивание текста для указания на его удаление.
• Аннотация подчеркивания текста: Подчеркивание и аннотирование текста для акцентирования.
• Аннотация водяного знака: Добавление текстовой аннотации водяного знака поверх документа.
• Аннотация волнистой линии: Использование волнистой линии для подчеркивания и привлечения внимания к тексту.

Специфические функции API

• Добавление аннотаций напрямую: Добавление аннотаций к документам без их скачивания.
• Примеры использования API: Доступ к примерному коду и документации для использования возможностей API.

Поддерживаемые форматы документов для облачного аннотирования

• 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
• Изображения: DJVU, JPEG, TIFF, BMP, GIF (статические изображения без анимации)
• Медицинские изображения: DICOM
• Разметка: HTML, MHTML
• Фиксированная верстка: PDF
• Метрафайлы: EMF, WMF

Требования

• Версия Java: Для создания клиентской библиотеки API требуется Java 1.7+.
• Инструмент сборки: Maven необходим для управления зависимостями и сборки проекта.

Необходимые условия

• Учетная запись GroupDocs Cloud: Для использования GroupDocs.Annotation Cloud SDK для Java вам необходимо зарегистрировать учетную запись в GroupDocs Cloud.
• ID клиента и секрет клиента: После регистрации вам необходимо получить или создать ваш ID клиента и секрет клиента на Cloud Dashboard.
• Бесплатная квота: GroupDocs Cloud предлагает бесплатную квоту для новых пользователей. Подробности можно узнать на странице GroupDocs Cloud Pricing.

Установка GroupDocs.Annotation-Cloud через Maven

Чтобы установить GroupDocs.Annotation Cloud SDK для Java, вам нужно добавить репозиторий GroupDocs Cloud в файл pom.xml вашего приложения:

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

Установка из исходного кода

Чтобы установить клиентскую библиотеку API из исходного кода, выполните следующие действия:

• Установить в локальное Maven-репозиторий: Чтобы установить библиотеку в локальный Maven-репозиторий, выполните следующую команду в терминале:

mvn clean install

• Развертывание в удаленный Maven-репозиторий: Если вы хотите развернуть библиотеку в удаленном Maven-репозитории, настройте параметры репозитория и выполните следующую команду:

mvn clean deploy

Для получения дополнительной информации о развертывании в удаленном репозитории обратитесь к OSSRH Guide.

Пользователи Maven

Если вы являетесь пользователем Maven, вы можете добавить GroupDocs.Annotation Cloud SDK для Java в качестве зависимости в файл pom.xml вашего проекта:

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

Начало работы

Чтобы начать работать с GroupDocs.Annotation Cloud SDK для Java, выполните следующие шаги:

1. Установка SDK: Установите SDK, следуя указанным выше шагам (с использованием Maven или установкой из исходного кода).
2. Конфигурация: Настройте конфигурацию, используя ваш ID клиента и секрет клиента, полученные с панели управления GroupDocs Cloud.
3. Пример кода: Внедрите пример кода в ваше приложение для добавления аннотаций, извлечения информации о документе или управления файлами и папками.
4. Документация: Обратитесь к инструкциям по быстрому старту и документации API для получения подробных примеров использования и дополнительной информации.

Авторизация и аутентификация

GroupDocs.Annotation Cloud SDK для Java использует OAuth 2.0 для авторизации и аутентификации. Ниже приведены соответствующие детали:

• Тип авторизации: OAuth 2.0
• Поток: Авторизация на основе приложений
• URL для авторизации: https://api.groupdocs.cloud/connect/token
• Время жизни токена: 1 день (по умолчанию)

JWT

GroupDocs.Annotation Cloud SDK использует JSON Web Tokens (JWT) для безопасного доступа к API:

• Тип токена: OAuth 2.0 JWT (JSON Web Token)
• URL для авторизации: Токены генерируются с использованием конечной точки https://api.groupdocs.cloud/connect/token.
• Срок действия токена: По умолчанию срок действия токена составляет 1 день, что обеспечивает безопасный, временно ограниченный доступ к API.

Эти детали предоставляют всеобъемлющее руководство по настройке и использованию GroupDocs.Annotation Cloud SDK для Java, охватывающее основные требования, этапы установки и настройки безопасности.

Ниже приведены два из наиболее полезных фрагментов кода, извлеченных из предоставленного содержания. Эти фрагменты демонстрируют основные функции, которые будут полезны потенциальным

пользователям, желающим интегрировать возможности аннотирования в свои приложения.

Пример кода на Java для добавления аннотации точки

Этот фрагмент демонстрирует, как добавить аннотацию точки в документ с использованием GroupDocs.Annotation Cloud SDK для Java. Аннотации точек полезны для пометки конкретных точек в документе с комментариями или заметками.

// Для полноценных примеров и данных перейдите на https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java-samples  
String MyAppKey = ""; // Получите AppKey и AppSID с https://dashboard.groupdocs.cloud  
String MyAppSid = ""; // Получите AppKey и AppSID с https://dashboard.groupdocs.cloud

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

// Создание аннотаций
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("Это аннотация точки");
annotations[0].setCreatorName("Anonym A.");

// Создание объекта запроса
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);

// Выполнение метода API
AnnotationApiLink result = apiInstance.annotate(request);
System.out.println("AddPointAnnotation: Аннотация точки добавлена: " + result.getTitle());

Пример кода на Java для добавления аннотации подсветки текста

Этот фрагмент кода показывает, как добавить аннотацию подсветки текста в документ. Подсветка текста является распространенной задачей аннотирования, особенно в процессе рецензирования, и этот фрагмент иллюстрирует, как это можно сделать программным способом.

// Для полноценных примеров и данных перейдите на https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java-samples  
String MyAppKey = ""; // Получите AppKey и AppSID с https://dashboard.groupdocs.cloud  
String MyAppSid = ""; // Получите AppKey и AppSID с https://dashboard.groupdocs.cloud

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

// Создание аннотаций
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("Этот текст выделен");
annotations[0].setCreatorName("Anonym A.");

// Создание объекта запроса
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);

// Выполнение метода API
AnnotationApiLink result = apiInstance.annotate(request);
System.out.println("AddTextHighlightAnnotation: Аннотация подсветки текста добавлена: " + result.getTitle());