Skip to content

Orpalis/passportpdfsdk-java

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

openapi-java-client

PassportPDF API

  • API version: 1.0.1
    • Build date: 2020-04-27T13:23:36.328+02:00[Europe/Paris]

Another brick in the cloud

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.7+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-java-client</artifactId>
  <version>1.0.1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "org.openapitools:openapi-java-client:1.0.1"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/openapi-java-client-1.0.1.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.models.*;
import org.openapitools.client.api.ConfigApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://passportpdfapi.com");

    ConfigApi apiInstance = new ConfigApi(defaultClient);
    try {
      String result = apiInstance.configGetAPIVersion();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ConfigApi#configGetAPIVersion");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to https://passportpdfapi.com

Class Method HTTP request Description
ConfigApi configGetAPIVersion GET /api/config/ConfigGetAPIVersion
ConfigApi configGetMaxAllowedContentLength GET /api/config/ConfigGetMaxAllowedContentLength Gets the maximal length of a request content, in bytes.
ConfigApi configGetSuggestedClientTimeout GET /api/config/ConfigGetSuggestedClientTimeout Gets the suggested client API timeout, in milliseconds.
ConfigApi configGetSuggestedMaxClientThreads GET /api/config/ConfigGetSuggestedMaxClientThreads Gets the suggested maximum number of threads to be used simultaneously by a client application.
ConfigApi configGetSupportedFonts GET /api/config/ConfigGetSupportedFonts Gets the list of supported fonts for text drawing operations.
ConfigApi configGetSupportedOCRLanguages GET /api/config/ConfigGetSupportedOCRLanguages Gets the list of supported languages for OCR.
DocuViewareApi docuViewareGetControl POST /api/docuvieware/DocuViewareGetControl Gets the HTML dom of a DocuVieware control.
DocuViewareApi docuViewareGetVersion GET /api/docuvieware/DocuViewareGetVersion Get the DocuVieware engine version.
DocuViewareApi docuViewareSave POST /api/docuvieware/DocuViewareSave Saves the document being handled by a specific DocuVieware control, in its current state.
DocumentApi documentClose POST /api/document/DocumentClose Closes a previously uploaded document.
DocumentApi documentGetPreview POST /api/document/DocumentGetPreview Gets the format, the page count and a thumbnail of a previously uploaded document.
DocumentApi documentLoad POST /api/document/DocumentLoad Loads the provided document file.
DocumentApi documentLoadFromURI POST /api/document/DocumentLoadFromURI Loads the provided document file from an URI.
DocumentApi documentLoadMultipart POST /api/document/DocumentLoadMultipart Loads the provided document file using Multipart Upload.
ImageApi imageAdjust POST /api/image/ImageAdjust Adjusts a previously uploaded image.
ImageApi imageAutoCrop POST /api/image/ImageAutoCrop Automatically crops a previously uploaded image.
ImageApi imageCleanupDocument POST /api/image/ImageCleanupDocument Cleanup a previously uploaded image.
ImageApi imageCloneRegions POST /api/image/ImageCloneRegions Clones regions from a previously uploaded image into new images.
ImageApi imageClose POST /api/image/ImageClose Closes a previously uploaded image.
ImageApi imageConvertColorDepth POST /api/image/ImageConvertColorDepth Converts the color depth of a previously uploaded image.
ImageApi imageCrop POST /api/image/ImageCrop Crops a previously uploaded image.
ImageApi imageDeletePage POST /api/image/ImageDeletePage Deletes a page range from a previously uploaded image.
ImageApi imageDetectBlankPages POST /api/image/ImageDetectBlankPages Detects the blank page(s) from a previously uploaded image and offers to remove them.
ImageApi imageDetectColor POST /api/image/ImageDetectColor Performs color detection on a previously uploaded image.
ImageApi imageDetectPageOrientation POST /api/image/ImageDetectPageOrientation Detects the orientation of the page(s) of a previously uploaded image and offers to automatically rotate them.
ImageApi imageFilter POST /api/image/ImageFilter Applies filters to a previously uploaded image.
ImageApi imageGetPageThumbnail POST /api/image/ImageGetPageThumbnail Gets a thumbnail of each page within the provided page range from a previously uploaded image.
ImageApi imageGetSupportedFileExtensions GET /api/image/ImageGetSupportedFileExtensions Gets the supported file extensions by the image loading actions.
ImageApi imageLoad POST /api/image/ImageLoad Loads the provided image file. Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.
ImageApi imageLoadMultipart POST /api/image/ImageLoadMultipart Loads the provided image file using Multipart Upload. Supported image formats can be retrieved by the GetSupportedImageFileExtensions action.
ImageApi imageMICR POST /api/image/ImageMICR Performs MICR (Magnetic Ink Character Recognition) on a previously uploaded image.
ImageApi imageReadBarcodes POST /api/image/ImageReadBarcodes Reads barcodes from a previously uploaded image.
ImageApi imageResize POST /api/image/ImageResize Resizes a previously uploaded image.
ImageApi imageRotate POST /api/image/ImageRotate Rotates and/or flips a previously uploaded image.
ImageApi imageSaveAsJPEG POST /api/image/ImageSaveAsJPEG Saves a previously uploaded image as JPEG, and sends the file data in a JSON-serialized object.
ImageApi imageSaveAsJPEGFile POST /api/image/ImageSaveAsJPEGFile Saves a previously uploaded image as JPEG, and streams the file binary data to the response (this is the most efficient download method).
ImageApi imageSaveAsPDF POST /api/image/ImageSaveAsPDF Saves a previously uploaded image as PDF, and sends the file data in a JSON-serialized object.
ImageApi imageSaveAsPDFFile POST /api/image/ImageSaveAsPDFFile Saves a previously uploaded image as PDF, and streams the file binary data to the response (this is the most efficient download method).
ImageApi imageSaveAsPDFMRC POST /api/image/ImageSaveAsPDFMRC Saves a previously uploaded image as PDF using MRC compression, and sends the file data in a JSON-serialized object.
ImageApi imageSaveAsPDFMRCFile POST /api/image/ImageSaveAsPDFMRCFile Saves a previously uploaded image as PDF using MRC compression, and streams the file binary data to the response (this is the most efficient download method).
ImageApi imageSaveAsPNG POST /api/image/ImageSaveAsPNG Saves a previously uploaded image as PNG, and sends the file data in a JSON-serialized object.
ImageApi imageSaveAsPNGFile POST /api/image/ImageSaveAsPNGFile Saves a previously uploaded image as PNG, and streams the file binary data to the response (this is the most efficient download method).
ImageApi imageSaveAsTIFF POST /api/image/ImageSaveAsTIFF Saves a previously uploaded image as TIFF, and sends the file data in a JSON-serialized object.
ImageApi imageSaveAsTIFFFile POST /api/image/ImageSaveAsTIFFFile Saves a previously uploaded image as TIFF, and streams the file binary data to the response (this is the most efficient download method).
ImageApi imageSaveAsTIFFMultipage POST /api/image/ImageSaveAsTIFFMultipage Saves a previously uploaded image as multipage TIFF, and sends the file data in a JSON-serialized object.
ImageApi imageSaveAsTIFFMultipageFile POST /api/image/ImageSaveAsTIFFMultipageFile Saves a previously uploaded image as multipage TIFF, and streams the file binary data to the response (this is the most efficient download method).
ImageApi imageSwapPages POST /api/image/ImageSwapPages Swaps two pages from a previously uploaded image.
PassportManagerApi passportManagerGetPassportInfo GET /api/passportmanager/PassportManagerGetPassportInfo
PassportPdfApplicationManagerApi passportPDFApplicationManagerGetApplicationDownloadLink GET /api/passportpdfapplicationmanager/PassportPDFApplicationManagerGetApplicationDownloadLink
PassportPdfApplicationManagerApi passportPDFApplicationManagerGetApplicationLatestVersion GET /api/passportpdfapplicationmanager/PassportPDFApplicationManagerGetApplicationLatestVersion
PassportPdfApplicationManagerApi passportPDFApplicationManagerGetApplicationMinimumSupportedVersion GET /api/passportpdfapplicationmanager/PassportPDFApplicationManagerGetApplicationMinimumSupportedVersion
PassportPdfApplicationManagerApi passportPDFApplicationManagerGetMaxClientThreads GET /api/passportpdfapplicationmanager/PassportPDFApplicationManagerGetMaxClientThreads Gets the maximum number of threads to be used simultaneously by a client application.
PdfApi annotate POST /api/pdf/Annotate Annotates a previously uploaded document.
PdfApi autoDeskew POST /api/pdf/AutoDeskew Performs auto deskew on a page range of a previously uploaded document.
PdfApi clearPage POST /api/pdf/ClearPage Clears a page range from a previously uploaded document.
PdfApi clonePage POST /api/pdf/ClonePage Clones specific pages from a previously uploaded document to another previously uploaded document.
PdfApi closePDF POST /api/pdf/ClosePDF Closes a previously uploaded document.
PdfApi convertToPDFA POST /api/pdf/ConvertToPDFA Converts a previously uploaded document to PDF/A.
PdfApi deletePage POST /api/pdf/DeletePage Deletes a page range from a previously uploaded document.
PdfApi detectPageOrientation POST /api/pdf/DetectPageOrientation Detects the orientation of the page(s) of a previously uploaded document and offers to automatically rotate them.
PdfApi digiSign POST /api/pdf/DigiSign Signs a previously uploaded document digitally.
PdfApi drawImage POST /api/pdf/DrawImage Draws an image on a page range of a previously uploaded document.
PdfApi extractPage POST /api/pdf/ExtractPage Extracts a page range from a previously uploaded document into one or several new documents.
PdfApi extractText POST /api/pdf/ExtractText Extracts text from the document pages.
PdfApi flatten POST /api/pdf/Flatten Flattens the form-fields, annotations, and/or the layers of a previously uploaded document.
PdfApi getInfo POST /api/pdf/GetInfo Gets information about a previously uploaded document.
PdfApi getPDFImportSupportedFileExtensions GET /api/pdf/GetPDFImportSupportedFileExtensions Gets the supported file extensions by the LoadDocumentAsPDF action.
PdfApi getPageThumbnail POST /api/pdf/GetPageThumbnail Gets a thumbnail of each page within the provided page range from a previously uploaded document.
PdfApi insertImage POST /api/pdf/InsertImage Inserts an image on a new page of a previously uploaded document.
PdfApi insertNewPage POST /api/pdf/InsertNewPage Inserts one or more new blank pages to a specific position in a previously uploaded document.
PdfApi insertPageNumber POST /api/pdf/InsertPageNumber Inserts page number(s) on a document.
PdfApi insertText POST /api/pdf/InsertText Inserts text on a document.
PdfApi linearize POST /api/pdf/Linearize Linearizes a previously uploaded document.
PdfApi loadDocumentAsPDF POST /api/pdf/LoadDocument Imports the provided document as PDF. Supported document formats can be retrieved by the GetPDFImportSupportedFileExtensions action.
PdfApi loadDocumentAsPDFMultipart POST /api/pdf/LoadDocumentAsPDFMultipart Imports the provided document as PDF using Multipart Upload. Supported document formats can be retrieved by the GetPDFImportSupportedFileExtensions action.
PdfApi merge POST /api/pdf/Merge Merges several previously uploaded documents into a new PDF.
PdfApi mergePages POST /api/pdf/MergePages Merges multiple pages, vertically, within a previously uploaded document into one single page.
PdfApi movePage POST /api/pdf/MovePage Moves a page range from a previously uploaded document.
PdfApi oCR POST /api/pdf/OCR Performs optical character recognition on a page range of a previously uploaded document. The recognized text is added as invisible text on each processed page. No token is charged for blank pages.
PdfApi protect POST /api/pdf/Protect Protects a previously uploaded document.
PdfApi readBarcodes POST /api/pdf/ReadBarcodes Reads barcodes from a previously uploaded document.
PdfApi reduce POST /api/pdf/Reduce Reduces the size of a previously uploaded document.
PdfApi removePageFormFields POST /api/pdf/RemovePageFormFields Removes the form fields from a page range of a previously uploaded document.
PdfApi removeText POST /api/pdf/RemoveText Removes text (all text or only invisible one) from a previously uploaded PDF.
PdfApi reorderPages POST /api/pdf/ReorderPages Reorders pages of a previously uploaded document.
PdfApi repairDocument POST /api/pdf/RepairDocument Repairs a previously uploaded PDF document.
PdfApi rotatePageStandard POST /api/pdf/RotatePageStandard Rotates (standardly) a page range from a previously uploaded document.
PdfApi saveAsJPEG POST /api/pdf/SaveAsJPEG Saves a previously uploaded document as JPEG, and sends the file data in a JSON-serialized object.
PdfApi saveAsJPEGFile POST /api/pdf/SaveAsJPEGFile Saves a previously uploaded document as JPEG, and streams the file binary data to the response (this is the most efficient download method).
PdfApi saveAsPNG POST /api/pdf/SaveAsPNG Saves a previously uploaded document as PNG, and sends the file data in a JSON-serialized object.
PdfApi saveAsPNGFile POST /api/pdf/SaveAsPNGFile Saves a previously uploaded document as PNG, and streams the file binary data to the response (this is the most efficient download method).
PdfApi saveAsTIFF POST /api/pdf/SaveAsTIFF Saves a previously uploaded document as TIFF, and sends the file data in a JSON-serialized object.
PdfApi saveAsTIFFFile POST /api/pdf/SaveAsTIFFFile Saves a previously uploaded document as TIFF, and streams the file binary data to the response (this is the most efficient download method).
PdfApi saveAsTIFFMultipage POST /api/pdf/SaveAsTIFFMultipage Saves a previously uploaded document as multipage TIFF, and sends the file data in a JSON-serialized object.
PdfApi saveAsTIFFMultipageFile POST /api/pdf/SaveAsTIFFMultipageFile Saves a previously uploaded document as multipage TIFF, and streams the file binary data to the response (this is the most efficient download method).
PdfApi saveDocument POST /api/pdf/SaveDocument Saves a previously uploaded document as PDF, and sends the file data in a JSON-serialized object.
PdfApi saveDocumentToFile POST /api/pdf/SaveDocumentToFile Saves a previously uploaded document as PDF, and streams the file binary data to the response (this is the most efficient download method).
PdfApi scalePage POST /api/pdf/ScalePage Scales a page range from a previously uploaded document.
PdfApi setInfo POST /api/pdf/SetInfo Sets information to a previously uploaded document.
PdfApi setInitialView POST /api/pdf/SetInitialView Sets various document level initial view options to a previously uploaded document.
PdfApi setPageBox POST /api/pdf/SetPageBox Sets pagebox to a page range from previously uploaded document.
PdfApi setPassword POST /api/pdf/SetPassword Unprotects a previously uploaded document.
PdfApi split POST /api/pdf/Split Splits a previously uploaded document into new ones.
PdfApi swapPages POST /api/pdf/SwapPages Swaps two pages from a previously uploaded document.
PdfApi unprotect POST /api/pdf/Unprotect Unprotects a previously uploaded document.

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

PassportPDFAuthentication

  • Type: API key
  • API key parameter name: X-PassportPDF-API-Key
  • Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

About

ORPALIS PassportPDF API Client SDK

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages