|
1 | | -# groupdocs-editor-cloud-java |
2 | | -Java library for communicating with the GroupDocs.Editor Cloud API |
| 1 | +# GroupDocs.Editor Cloud SDK for Java |
| 2 | +This repository contains GroupDocs.Editor Cloud SDK for Java source code. This SDK allows you to work with GroupDocs.Editor Cloud REST APIs in your Java applications. |
| 3 | + |
| 4 | +GroupDocs.Editor Cloud allows you to edit documents across wide range of supported document types - DOCX/DOC, PPTX/PPT, XLSX/XLS, ODT, ODS, ODP, TSV/DSV, TXT. |
| 5 | +## Requirements |
| 6 | + |
| 7 | +Building the API client library requires [Maven](https://maven.apache.org/) to be installed. |
| 8 | + |
| 9 | +## Installation |
| 10 | + |
| 11 | +To install the API client library to your local Maven repository, execute: |
| 12 | + |
| 13 | +```shell |
| 14 | +mvn install |
| 15 | +``` |
| 16 | + |
| 17 | +To deploy it to a remote Maven repository instead, configure the settings of the repository and execute: |
| 18 | + |
| 19 | +```shell |
| 20 | +mvn deploy |
| 21 | +``` |
| 22 | + |
| 23 | +Refer to the [official documentation](https://maven.apache.org/plugins/maven-deploy-plugin/usage.html) for more information. |
| 24 | + |
| 25 | +### Maven users |
| 26 | + |
| 27 | +Add following repository and dependency to your project's POM |
| 28 | + |
| 29 | +```xml |
| 30 | +<repository> |
| 31 | + <id>groupdocs-artifact-repository</id> |
| 32 | + <name>GroupDocs Artifact Repository</name> |
| 33 | + <url>https://repository.groupdocs.cloud/repo</url> |
| 34 | +</repository> |
| 35 | +``` |
| 36 | + |
| 37 | +```xml |
| 38 | +<dependency> |
| 39 | + <groupId>com.groupdocs</groupId> |
| 40 | + <artifactId>groupdocs-editor-cloud</artifactId> |
| 41 | + <version>19.11</version> |
| 42 | + <scope>compile</scope> |
| 43 | +</dependency> |
| 44 | +``` |
| 45 | + |
| 46 | +### Others |
| 47 | + |
| 48 | +At first generate the JAR by executing: |
| 49 | + |
| 50 | + mvn package |
| 51 | + |
| 52 | +Then manually install the following JARs: |
| 53 | + |
| 54 | +* target/groupdocs-editor-cloud-19.11.jar |
| 55 | +* target/lib/*.jar |
| 56 | + |
| 57 | +## Getting Started |
| 58 | + |
| 59 | +Please follow the [installation](#installation) instruction and execute the following Java code: |
| 60 | + |
| 61 | +```java |
| 62 | +import com.groupdocs.cloud.editor.client.*; |
| 63 | +import com.groupdocs.cloud.editor.model.*; |
| 64 | +import com.groupdocs.cloud.editor.api.InfoApi; |
| 65 | + |
| 66 | +import java.util.*; |
| 67 | + |
| 68 | +public class ApiExample { |
| 69 | + |
| 70 | + public static void main(String[] args) { |
| 71 | + //TODO: Get your AppSID and AppKey at https://dashboard.groupdocs.cloud (free registration is required). |
| 72 | + String appSid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"; |
| 73 | + String appKey = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"; |
| 74 | + |
| 75 | + Configuration configuration = new Configuration(appSid, appKey); |
| 76 | + |
| 77 | + InfoApi infoApi = new InfoApi(configuration); |
| 78 | + |
| 79 | + try { |
| 80 | + FormatsResult response = infoApi.getSupportedFileFormats(); |
| 81 | + for (Format format : response.getFormats()) { |
| 82 | + System.out.println(format.getFileFormat()); |
| 83 | + } |
| 84 | + } catch (ApiException e) { |
| 85 | + System.err.println("Failed to get supported file formats"); |
| 86 | + e.printStackTrace(); |
| 87 | + } |
| 88 | + } |
| 89 | +} |
| 90 | +``` |
| 91 | + |
| 92 | +## Licensing |
| 93 | +All GroupDocs.Editor Cloud SDKs are licensed under [MIT License](LICENSE). |
| 94 | + |
| 95 | +## Resources |
| 96 | ++ [**Website**](https://www.groupdocs.cloud) |
| 97 | ++ [**Product Home**](https://products.groupdocs.cloud/editor) |
| 98 | ++ [**Documentation**](https://docs.groupdocs.cloud/display/editorcloud/Home) |
| 99 | ++ [**Free Support Forum**](https://forum.groupdocs.cloud/c/editor) |
| 100 | ++ [**Blog**](https://blog.groupdocs.cloud/category/editor) |
| 101 | + |
| 102 | +## Contact Us |
| 103 | +Your feedback is very important to us. Please feel free to contact us using our [Support Forums](https://forum.groupdocs.cloud/c/editor). |
0 commit comments