|
| 1 | +# Aspose.BarCode Cloud SDK for Java |
| 2 | + |
| 3 | +Aspose.Barcode Cloud API Reference |
| 4 | +- API version: 3.0 |
| 5 | + |
| 6 | +No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) |
| 7 | + |
| 8 | + |
| 9 | +*Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)* |
| 10 | + |
| 11 | + |
| 12 | +## Requirements |
| 13 | + |
| 14 | +Building the API client library requires: |
| 15 | +1. Java 1.7+ |
| 16 | +2. Maven/Gradle |
| 17 | + |
| 18 | +## Installation |
| 19 | + |
| 20 | +To install the API client library to your local Maven repository, simply execute: |
| 21 | + |
| 22 | +```shell |
| 23 | +mvn clean install |
| 24 | +``` |
| 25 | + |
| 26 | +To deploy it to a remote Maven repository instead, configure the settings of the repository and execute: |
| 27 | + |
| 28 | +```shell |
| 29 | +mvn clean deploy |
| 30 | +``` |
| 31 | + |
| 32 | +Refer to the [OSSRH Guide](http://central.sonatype.org/pages/ossrh-guide.html) for more information. |
| 33 | + |
| 34 | +### Maven users |
| 35 | + |
| 36 | +Add this dependency to your project's POM: |
| 37 | + |
| 38 | +```xml |
| 39 | +<dependency> |
| 40 | + <groupId>com.aspose</groupId> |
| 41 | + <artifactId>aspose-barcode-cloud</artifactId> |
| 42 | + <version>20.8.0</version> |
| 43 | + <scope>compile</scope> |
| 44 | +</dependency> |
| 45 | +``` |
| 46 | + |
| 47 | +### Gradle users |
| 48 | + |
| 49 | +Add this dependency to your project's build file: |
| 50 | + |
| 51 | +```groovy |
| 52 | +compile "com.aspose:aspose-barcode-cloud:20.8.0" |
| 53 | +``` |
| 54 | + |
| 55 | +### Others |
| 56 | + |
| 57 | +At first generate the JAR by executing: |
| 58 | + |
| 59 | +```shell |
| 60 | +mvn clean package |
| 61 | +``` |
| 62 | + |
| 63 | +Then manually install the following JARs: |
| 64 | + |
| 65 | +* `target/aspose-barcode-cloud-20.8.0.jar` |
| 66 | +* `target/lib/*.jar` |
| 67 | + |
| 68 | +## Getting Started |
| 69 | + |
| 70 | +Please follow the [installation](#installation) instruction and execute the following Java code: |
| 71 | + |
| 72 | +```java |
| 73 | + |
| 74 | +import com.aspose.barcode.cloud.*; |
| 75 | +import com.aspose.barcode.cloud.auth.*; |
| 76 | +import com.aspose.barcode.cloud.model.*; |
| 77 | +import com.aspose.barcode.cloud.api.BarcodeApi; |
| 78 | + |
| 79 | +import java.io.File; |
| 80 | +import java.util.*; |
| 81 | + |
| 82 | +public class BarcodeApiExample { |
| 83 | + |
| 84 | + public static void main(String[] args) { |
| 85 | + ApiClient defaultClient = Configuration.getDefaultApiClient(); |
| 86 | + |
| 87 | + // Configure OAuth2 access token for authorization: JWT |
| 88 | + OAuth JWT = (OAuth) defaultClient.getAuthentication("JWT"); |
| 89 | + JWT.setAccessToken("YOUR ACCESS TOKEN"); |
| 90 | + |
| 91 | + BarcodeApi apiInstance = new BarcodeApi(); |
| 92 | + String type = "type_example"; // String | Type of barcode to generate. |
| 93 | + String text = "text_example"; // String | Text to encode. |
| 94 | + String twoDDisplayText = "twoDDisplayText_example"; // String | Text that will be displayed instead of codetext in 2D barcodes. Used for: Aztec, Pdf417, DataMatrix, QR, MaxiCode, DotCode |
| 95 | + String textLocation = "textLocation_example"; // String | Specify the displaying Text Location, set to CodeLocation.None to hide CodeText. Default value: CodeLocation.Below. |
| 96 | + String textAlignment = "textAlignment_example"; // String | Text alignment. |
| 97 | + String textColor = "textColor_example"; // String | Specify the displaying CodeText's Color. Default value: Color.Black. |
| 98 | + String fontSizeMode = "fontSizeMode_example"; // String | Specify FontSizeMode. If FontSizeMode is set to Auto, font size will be calculated automatically based on xDimension value. It is recommended to use FontSizeMode.Auto especially in AutoSizeMode.Nearest or AutoSizeMode.Interpolation. Default value: FontSizeMode.Auto. |
| 99 | + Double resolution = 3.4D; // Double | Resolution of the BarCode image. One value for both dimensions. Default value: 96 dpi. |
| 100 | + Double resolutionX = 3.4D; // Double | DEPRECATED: Use 'Resolution' instead. |
| 101 | + Double resolutionY = 3.4D; // Double | DEPRECATED: Use 'Resolution' instead. |
| 102 | + Double dimensionX = 3.4D; // Double | The smallest width of the unit of BarCode bars or spaces. Increase this will increase the whole barcode image width. Ignored if AutoSizeMode property is set to AutoSizeMode.Nearest or AutoSizeMode.Interpolation. |
| 103 | + Double textSpace = 3.4D; // Double | Space between the CodeText and the BarCode in Unit value. Default value: 2pt. Ignored for EAN8, EAN13, UPCE, UPCA, ISBN, ISMN, ISSN, UpcaGs1DatabarCoupon. |
| 104 | + String units = "units_example"; // String | Common Units for all measuring in query. Default units: pixel. |
| 105 | + String sizeMode = "sizeMode_example"; // String | Specifies the different types of automatic sizing modes. Default value: AutoSizeMode.None. |
| 106 | + Double barHeight = 3.4D; // Double | Height of the barcode in given units. Default units: pixel. |
| 107 | + Double imageHeight = 3.4D; // Double | Height of the barcode image in given units. Default units: pixel. |
| 108 | + Double imageWidth = 3.4D; // Double | Width of the barcode image in given units. Default units: pixel. |
| 109 | + Double rotationAngle = 3.4D; // Double | BarCode image rotation angle, measured in degree, e.g. RotationAngle = 0 or RotationAngle = 360 means no rotation. If RotationAngle NOT equal to 90, 180, 270 or 0, it may increase the difficulty for the scanner to read the image. Default value: 0. |
| 110 | + String backColor = "backColor_example"; // String | Background color of the barcode image. Default value: Color.White. |
| 111 | + String barColor = "barColor_example"; // String | Bars color. Default value: Color.Black. |
| 112 | + String borderColor = "borderColor_example"; // String | Border color. Default value: Color.Black. |
| 113 | + Double borderWidth = 3.4D; // Double | Border width. Default value: 0. Ignored if Visible is set to false. |
| 114 | + String borderDashStyle = "borderDashStyle_example"; // String | Border dash style. Default value: BorderDashStyle.Solid. |
| 115 | + Boolean borderVisible = true; // Boolean | Border visibility. If false than parameter Width is always ignored (0). Default value: false. |
| 116 | + String enableChecksum = "enableChecksum_example"; // String | Enable checksum during generation 1D barcodes. Default is treated as Yes for symbology which must contain checksum, as No where checksum only possible. Checksum is possible: Code39 Standard/Extended, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, DeutschePostIdentcode, DeutschePostLeitcode, VIN, Codabar Checksum always used: Rest symbology |
| 117 | + Boolean enableEscape = true; // Boolean | Indicates whether explains the character \"\\\" as an escape character in CodeText property. Used for Pdf417, DataMatrix, Code128 only If the EnableEscape is true, \"\\\" will be explained as a special escape character. Otherwise, \"\\\" acts as normal characters. Aspose.BarCode supports input decimal ascii code and mnemonic for ASCII control-code characters. For example, \\013 and \\\\CR stands for CR. |
| 118 | + Boolean filledBars = true; // Boolean | Value indicating whether bars are filled. Only for 1D barcodes. Default value: true. |
| 119 | + Boolean alwaysShowChecksum = true; // Boolean | Always display checksum digit in the human readable text for Code128 and GS1Code128 barcodes. |
| 120 | + Double wideNarrowRatio = 3.4D; // Double | Wide bars to Narrow bars ratio. Default value: 3, that is, wide bars are 3 times as wide as narrow bars. Used for ITF, PZN, PharmaCode, Standard2of5, Interleaved2of5, Matrix2of5, ItalianPost25, IATA2of5, VIN, DeutschePost, OPC, Code32, DataLogic2of5, PatchCode, Code39Extended, Code39Standard |
| 121 | + Boolean validateText = true; // Boolean | Only for 1D barcodes. If codetext is incorrect and value set to true - exception will be thrown. Otherwise codetext will be corrected to match barcode's specification. Exception always will be thrown for: Databar symbology if codetext is incorrect. Exception always will not be thrown for: AustraliaPost, SingaporePost, Code39Extended, Code93Extended, Code16K, Code128 symbology if codetext is incorrect. |
| 122 | + String supplementData = "supplementData_example"; // String | Supplement parameters. Used for Interleaved2of5, Standard2of5, EAN13, EAN8, UPCA, UPCE, ISBN, ISSN, ISMN. |
| 123 | + Double supplementSpace = 3.4D; // Double | Space between main the BarCode and supplement BarCode. |
| 124 | + String format = "format_example"; // String | Result image format. |
| 125 | + try { |
| 126 | + File result = apiInstance.getBarcodeGenerate(type, text, twoDDisplayText, textLocation, textAlignment, textColor, fontSizeMode, resolution, resolutionX, resolutionY, dimensionX, textSpace, units, sizeMode, barHeight, imageHeight, imageWidth, rotationAngle, backColor, barColor, borderColor, borderWidth, borderDashStyle, borderVisible, enableChecksum, enableEscape, filledBars, alwaysShowChecksum, wideNarrowRatio, validateText, supplementData, supplementSpace, format); |
| 127 | + System.out.println(result); |
| 128 | + } catch (ApiException e) { |
| 129 | + System.err.println("Exception when calling BarcodeApi#getBarcodeGenerate"); |
| 130 | + e.printStackTrace(); |
| 131 | + } |
| 132 | + } |
| 133 | +} |
| 134 | + |
| 135 | +``` |
| 136 | + |
| 137 | +## Documentation for API Endpoints |
| 138 | + |
| 139 | +All URIs are relative to *https://api.aspose.cloud/v3.0* |
| 140 | + |
| 141 | +Class | Method | HTTP request | Description |
| 142 | +------------ | ------------- | ------------- | ------------- |
| 143 | +*BarcodeApi* | [**getBarcodeGenerate**](docs/BarcodeApi.md#getBarcodeGenerate) | **GET** /barcode/generate | Generate barcode. |
| 144 | +*BarcodeApi* | [**getBarcodeRecognize**](docs/BarcodeApi.md#getBarcodeRecognize) | **GET** /barcode/{name}/recognize | Recognize barcode from a file on server. |
| 145 | +*BarcodeApi* | [**postBarcodeRecognizeFromUrlOrContent**](docs/BarcodeApi.md#postBarcodeRecognizeFromUrlOrContent) | **POST** /barcode/recognize | Recognize barcode from an url or from request body. Request body can contain raw data bytes of the image or encoded with base64. |
| 146 | +*BarcodeApi* | [**postGenerateMultiple**](docs/BarcodeApi.md#postGenerateMultiple) | **POST** /barcode/generateMultiple | Generate multiple barcodes and return in response stream |
| 147 | +*BarcodeApi* | [**putBarcodeGenerateFile**](docs/BarcodeApi.md#putBarcodeGenerateFile) | **PUT** /barcode/{name}/generate | Generate barcode and save on server (from query params or from file with json or xml content) |
| 148 | +*BarcodeApi* | [**putBarcodeRecognizeFromBody**](docs/BarcodeApi.md#putBarcodeRecognizeFromBody) | **PUT** /barcode/{name}/recognize | Recognition of a barcode from file on server with parameters in body. |
| 149 | +*BarcodeApi* | [**putGenerateMultiple**](docs/BarcodeApi.md#putGenerateMultiple) | **PUT** /barcode/{name}/generateMultiple | Generate image with multiple barcodes and put new file on server |
| 150 | +*FileApi* | [**copyFile**](docs/FileApi.md#copyFile) | **PUT** /barcode/storage/file/copy/{srcPath} | Copy file |
| 151 | +*FileApi* | [**deleteFile**](docs/FileApi.md#deleteFile) | **DELETE** /barcode/storage/file/{path} | Delete file |
| 152 | +*FileApi* | [**downloadFile**](docs/FileApi.md#downloadFile) | **GET** /barcode/storage/file/{path} | Download file |
| 153 | +*FileApi* | [**moveFile**](docs/FileApi.md#moveFile) | **PUT** /barcode/storage/file/move/{srcPath} | Move file |
| 154 | +*FileApi* | [**uploadFile**](docs/FileApi.md#uploadFile) | **PUT** /barcode/storage/file/{path} | Upload file |
| 155 | +*FolderApi* | [**copyFolder**](docs/FolderApi.md#copyFolder) | **PUT** /barcode/storage/folder/copy/{srcPath} | Copy folder |
| 156 | +*FolderApi* | [**createFolder**](docs/FolderApi.md#createFolder) | **PUT** /barcode/storage/folder/{path} | Create the folder |
| 157 | +*FolderApi* | [**deleteFolder**](docs/FolderApi.md#deleteFolder) | **DELETE** /barcode/storage/folder/{path} | Delete folder |
| 158 | +*FolderApi* | [**getFilesList**](docs/FolderApi.md#getFilesList) | **GET** /barcode/storage/folder/{path} | Get all files and folders within a folder |
| 159 | +*FolderApi* | [**moveFolder**](docs/FolderApi.md#moveFolder) | **PUT** /barcode/storage/folder/move/{srcPath} | Move folder |
| 160 | +*StorageApi* | [**getDiscUsage**](docs/StorageApi.md#getDiscUsage) | **GET** /barcode/storage/disc | Get disc usage |
| 161 | +*StorageApi* | [**getFileVersions**](docs/StorageApi.md#getFileVersions) | **GET** /barcode/storage/version/{path} | Get file versions |
| 162 | +*StorageApi* | [**objectExists**](docs/StorageApi.md#objectExists) | **GET** /barcode/storage/exist/{path} | Check if file or folder exists |
| 163 | +*StorageApi* | [**storageExists**](docs/StorageApi.md#storageExists) | **GET** /barcode/storage/{storageName}/exist | Check if storage exists |
| 164 | + |
| 165 | + |
| 166 | +## Documentation for Models |
| 167 | + |
| 168 | + - [AustralianPostParams](docs/AustralianPostParams.md) |
| 169 | + - [AutoSizeMode](docs/AutoSizeMode.md) |
| 170 | + - [AvailableGraphicsUnit](docs/AvailableGraphicsUnit.md) |
| 171 | + - [AztecParams](docs/AztecParams.md) |
| 172 | + - [AztecSymbolMode](docs/AztecSymbolMode.md) |
| 173 | + - [BarCodeErrorResponse](docs/BarCodeErrorResponse.md) |
| 174 | + - [BarcodeResponse](docs/BarcodeResponse.md) |
| 175 | + - [BarcodeResponseList](docs/BarcodeResponseList.md) |
| 176 | + - [BorderDashStyle](docs/BorderDashStyle.md) |
| 177 | + - [CaptionParams](docs/CaptionParams.md) |
| 178 | + - [ChecksumValidation](docs/ChecksumValidation.md) |
| 179 | + - [CodabarChecksumMode](docs/CodabarChecksumMode.md) |
| 180 | + - [CodabarParams](docs/CodabarParams.md) |
| 181 | + - [CodabarSymbol](docs/CodabarSymbol.md) |
| 182 | + - [CodablockParams](docs/CodablockParams.md) |
| 183 | + - [Code16KParams](docs/Code16KParams.md) |
| 184 | + - [CodeLocation](docs/CodeLocation.md) |
| 185 | + - [CouponParams](docs/CouponParams.md) |
| 186 | + - [CustomerInformationInterpretingType](docs/CustomerInformationInterpretingType.md) |
| 187 | + - [DataBarParams](docs/DataBarParams.md) |
| 188 | + - [DataMatrixEccType](docs/DataMatrixEccType.md) |
| 189 | + - [DataMatrixEncodeMode](docs/DataMatrixEncodeMode.md) |
| 190 | + - [DataMatrixParams](docs/DataMatrixParams.md) |
| 191 | + - [DecodeBarcodeType](docs/DecodeBarcodeType.md) |
| 192 | + - [DiscUsage](docs/DiscUsage.md) |
| 193 | + - [DotCodeParams](docs/DotCodeParams.md) |
| 194 | + - [ECIEncodings](docs/ECIEncodings.md) |
| 195 | + - [EnableChecksum](docs/EnableChecksum.md) |
| 196 | + - [EncodeBarcodeType](docs/EncodeBarcodeType.md) |
| 197 | + - [Error](docs/Error.md) |
| 198 | + - [ErrorDetails](docs/ErrorDetails.md) |
| 199 | + - [FileVersions](docs/FileVersions.md) |
| 200 | + - [FilesList](docs/FilesList.md) |
| 201 | + - [FilesUploadResult](docs/FilesUploadResult.md) |
| 202 | + - [FontMode](docs/FontMode.md) |
| 203 | + - [FontParams](docs/FontParams.md) |
| 204 | + - [FontStyle](docs/FontStyle.md) |
| 205 | + - [GeneratorParams](docs/GeneratorParams.md) |
| 206 | + - [GeneratorParamsList](docs/GeneratorParamsList.md) |
| 207 | + - [ITF14BorderType](docs/ITF14BorderType.md) |
| 208 | + - [ITFParams](docs/ITFParams.md) |
| 209 | + - [MaxiCodeParams](docs/MaxiCodeParams.md) |
| 210 | + - [ObjectExist](docs/ObjectExist.md) |
| 211 | + - [Padding](docs/Padding.md) |
| 212 | + - [PatchCodeParams](docs/PatchCodeParams.md) |
| 213 | + - [PatchFormat](docs/PatchFormat.md) |
| 214 | + - [Pdf417CompactionMode](docs/Pdf417CompactionMode.md) |
| 215 | + - [Pdf417ErrorLevel](docs/Pdf417ErrorLevel.md) |
| 216 | + - [Pdf417Params](docs/Pdf417Params.md) |
| 217 | + - [PostalParams](docs/PostalParams.md) |
| 218 | + - [PresetType](docs/PresetType.md) |
| 219 | + - [QREncodeMode](docs/QREncodeMode.md) |
| 220 | + - [QREncodeType](docs/QREncodeType.md) |
| 221 | + - [QRErrorLevel](docs/QRErrorLevel.md) |
| 222 | + - [QRVersion](docs/QRVersion.md) |
| 223 | + - [QrParams](docs/QrParams.md) |
| 224 | + - [ReaderParams](docs/ReaderParams.md) |
| 225 | + - [RegionPoint](docs/RegionPoint.md) |
| 226 | + - [ResultImageInfo](docs/ResultImageInfo.md) |
| 227 | + - [StorageExist](docs/StorageExist.md) |
| 228 | + - [StorageFile](docs/StorageFile.md) |
| 229 | + - [TextAlignment](docs/TextAlignment.md) |
| 230 | + - [FileVersion](docs/FileVersion.md) |
| 231 | + |
| 232 | + |
| 233 | +## Documentation for Authorization |
| 234 | + |
| 235 | +Authentication schemes defined for the API: |
| 236 | +### JWT |
| 237 | + |
| 238 | +- **Type**: OAuth |
| 239 | +- **Flow**: application |
| 240 | +- **Authorization URL**: |
| 241 | +- **Scopes**: N/A |
| 242 | + |
| 243 | + |
| 244 | +## Recommendation |
| 245 | + |
| 246 | +It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues. |
| 247 | + |
| 248 | +## Author |
| 249 | + |
| 250 | + |
| 251 | + |
0 commit comments