RU | EN

Maticon Office DocSpace SDK для Java

Java SDK для интеграции приложений с Maticon Office DocSpace API. Версия 3.7.0 содержит типизированные API-клиенты, модели запросов и ответов, поддержку основных схем аутентификации и сгенерированную документацию по методам.

Координаты

• Maven group: ru.maticonoffice
• Artifact: docspace-api-sdk
• Версия: 3.7.0
• Репозиторий: github.com/MaticonOffice/docspace-api-sdk-java
• Java package API-клиента: org.openapitools.client

Java package сохраняет нейтральное имя, используемое сгенерированным клиентом. Публикационные координаты Maven принадлежат Maticon Office.

Требования

• JDK 8 или новее для использования библиотеки.
• Maven или Gradle для сборки проекта.

Установка

Maven:

<dependency>
  <groupId>ru.maticonoffice</groupId>
  <artifactId>docspace-api-sdk</artifactId>
  <version>3.7.0</version>
</dependency>

Gradle:

dependencies {
    implementation 'ru.maticonoffice:docspace-api-sdk:3.7.0'
}

Быстрый старт

import org.openapitools.client.ApiClient;
import org.openapitools.client.Configuration;
import org.openapitools.client.api.Files.FoldersApi;

public final class Example {
    public static void main(String[] args) {
        String token = System.getenv("MATICONOFFICE_TOKEN");
        if (token == null || token.isEmpty()) {
            throw new IllegalStateException("MATICONOFFICE_TOKEN is not set");
        }

        ApiClient client = Configuration.getDefaultApiClient();
        client.setBasePath("https://your-docspace.maticonoffice.ru");
        client.setBearerToken(token);

        FoldersApi foldersApi = new FoldersApi(client);
        // Вызовите нужный метод foldersApi с параметрами из docs/FilesFoldersApi.md.
    }
}

Не храните логины, пароли, API-ключи и токены в исходном коде. Загружайте их из секрет-хранилища, переменных окружения или защищенной конфигурации.

Аутентификация

SDK поддерживает схемы, объявленные в OpenAPI:

• Bearer token.
• API key через ApiKeyBearer.
• HTTP Basic.
• OAuth 2.0 Authorization Code.
• OpenID Connect.
• Cookie asc_auth_key и значение x-signature для методов, где они обязательны.

Имена asc_auth_key, ApiKeyBearer и x-signature являются идентификаторами API-контракта и не должны переименовываться.

Структура SDK

• src/main/java/org/openapitools/client/api - API-клиенты по функциональным группам.
• src/main/java/org/openapitools/client/model - модели запросов и ответов.
• src/main/java/org/openapitools/client - HTTP-клиент, конфигурация и обработка ошибок.
• docs - подробная сгенерированная документация по API и моделям.
• api/openapi.yaml - спецификация Maticon Office DocSpace API 3.7.0.
• samples/sample.java - пример аутентификации и работы с файлами, комнатами и резервным копированием.

Обработка ошибок

Методы SDK выбрасывают org.openapitools.client.ApiException. При обработке проверяйте HTTP-код, тело ответа и заголовки, не записывая секреты в журнал:

try {
    // Вызов API.
} catch (org.openapitools.client.ApiException ex) {
    System.err.println("DocSpace API error: " + ex.getCode());
    System.err.println(ex.getResponseBody());
}

Сборка из исходников

Maven:

mvn --batch-mode clean verify
mvn --batch-mode install

Gradle на Linux/macOS:

./gradlew clean build

Gradle на Windows:

.\gradlew.bat clean build

Артефакты Maven создаются в target, Gradle - в build/libs.

Документация и поддержка

• Справочник API: api.maticonoffice.ru
• Поддержка: support.maticonoffice.ru
• Локальная справка: каталог docs

Лицензия

SDK распространяется по лицензии Apache License 2.0. Полный текст находится в файле LICENSE. Исходные уведомления об авторских правах и имена правообладателей в коде сохранены без изменений.