Skip to content

Orpalis/passportpdfsdk-php

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
.openapi-generator
.openapi-generator
 
 
docs
docs
 
 
lib
lib
 
 
test
test
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.php_cs
.php_cs
 
 
.travis.yml
.travis.yml
 
 
README.md
README.md
 
 
composer.json
composer.json
 
 
git_push.sh
git_push.sh
 
 
phpunit.xml.dist
phpunit.xml.dist
 
 

Repository files navigation

OpenAPIClient-php

Another brick in the cloud

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.1
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\ConfigApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->configGetAPIVersion();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigApi->configGetAPIVersion: ', $e->getMessage(), PHP_EOL;
}

?>

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.
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.
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.

Documentation For Models

Documentation For Authorization

PassportPDFAuthentication

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

Author

About

ORPALIS PassportPDF API Client SDK

Resources

Readme
Activity
Custom properties

Stars

1 star

Watchers

4 watching

Forks

1 fork
Report repository

Releases

No releases published

Packages

No packages published

Languages