ServicesApi

All URIs are relative to https://us1.pdfgeneratorapi.com/api/v4

Method	HTTP request	Description
addWatermark	POST /pdfservices/watermark	Add watermark
decryptDocument	POST /pdfservices/decrypt	Decrypt document
encryptDocument	POST /pdfservices/encrypt	Encrypt document
extractFormFields	POST /pdfservices/form/fields	Extract form fields
fillFormFields	POST /pdfservices/form/fill	Fill form fields
optimizeDocument	POST /pdfservices/optimize	Optimize document

addWatermark

AddWatermark201Response addWatermark(addWatermarkRequest)

Add watermark

Adds a text or an image watermark to PDF document from base64 string or a remote URL.

Example

// Import classes:
import org.pdfgeneratorapi.client.ApiClient;
import org.pdfgeneratorapi.client.ApiException;
import org.pdfgeneratorapi.client.Configuration;
import org.pdfgeneratorapi.client.auth.*;
import org.pdfgeneratorapi.client.models.*;
import org.pdfgeneratorapi.client.api.ServicesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://us1.pdfgeneratorapi.com/api/v4");
    
    // Configure HTTP bearer authorization: JSONWebTokenAuth
    HttpBearerAuth JSONWebTokenAuth = (HttpBearerAuth) defaultClient.getAuthentication("JSONWebTokenAuth");
    JSONWebTokenAuth.setBearerToken("BEARER TOKEN");

    ServicesApi apiInstance = new ServicesApi(defaultClient);
    AddWatermarkRequest addWatermarkRequest = new AddWatermarkRequest(); // AddWatermarkRequest | 
    try {
      AddWatermark201Response result = apiInstance.addWatermark(addWatermarkRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ServicesApi#addWatermark");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
addWatermarkRequest	AddWatermarkRequest

Return type

AddWatermark201Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Document data	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

decryptDocument

AddWatermark201Response decryptDocument(encryptDocumentRequest)

Decrypt document

Decrypts an encrypted PDF document from base64 string or a remote URL.

Example

// Import classes:
import org.pdfgeneratorapi.client.ApiClient;
import org.pdfgeneratorapi.client.ApiException;
import org.pdfgeneratorapi.client.Configuration;
import org.pdfgeneratorapi.client.auth.*;
import org.pdfgeneratorapi.client.models.*;
import org.pdfgeneratorapi.client.api.ServicesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://us1.pdfgeneratorapi.com/api/v4");
    
    // Configure HTTP bearer authorization: JSONWebTokenAuth
    HttpBearerAuth JSONWebTokenAuth = (HttpBearerAuth) defaultClient.getAuthentication("JSONWebTokenAuth");
    JSONWebTokenAuth.setBearerToken("BEARER TOKEN");

    ServicesApi apiInstance = new ServicesApi(defaultClient);
    EncryptDocumentRequest encryptDocumentRequest = new EncryptDocumentRequest(); // EncryptDocumentRequest | 
    try {
      AddWatermark201Response result = apiInstance.decryptDocument(encryptDocumentRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ServicesApi#decryptDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
encryptDocumentRequest	EncryptDocumentRequest

Return type

AddWatermark201Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Document data	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

encryptDocument

AddWatermark201Response encryptDocument(encryptDocumentRequest)

Encrypt document

Encrypts a PDF document from base64 string or a remote URL.

Example

// Import classes:
import org.pdfgeneratorapi.client.ApiClient;
import org.pdfgeneratorapi.client.ApiException;
import org.pdfgeneratorapi.client.Configuration;
import org.pdfgeneratorapi.client.auth.*;
import org.pdfgeneratorapi.client.models.*;
import org.pdfgeneratorapi.client.api.ServicesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://us1.pdfgeneratorapi.com/api/v4");
    
    // Configure HTTP bearer authorization: JSONWebTokenAuth
    HttpBearerAuth JSONWebTokenAuth = (HttpBearerAuth) defaultClient.getAuthentication("JSONWebTokenAuth");
    JSONWebTokenAuth.setBearerToken("BEARER TOKEN");

    ServicesApi apiInstance = new ServicesApi(defaultClient);
    EncryptDocumentRequest encryptDocumentRequest = new EncryptDocumentRequest(); // EncryptDocumentRequest | 
    try {
      AddWatermark201Response result = apiInstance.encryptDocument(encryptDocumentRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ServicesApi#encryptDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
encryptDocumentRequest	EncryptDocumentRequest

Return type

AddWatermark201Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Document data	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

extractFormFields

ExtractFormFields200Response extractFormFields(extractFormFieldsRequest)

Extract form fields

Extracts form fields and their metadata from a PDF document using base64 string or a remote URL.

Example

// Import classes:
import org.pdfgeneratorapi.client.ApiClient;
import org.pdfgeneratorapi.client.ApiException;
import org.pdfgeneratorapi.client.Configuration;
import org.pdfgeneratorapi.client.auth.*;
import org.pdfgeneratorapi.client.models.*;
import org.pdfgeneratorapi.client.api.ServicesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://us1.pdfgeneratorapi.com/api/v4");
    
    // Configure HTTP bearer authorization: JSONWebTokenAuth
    HttpBearerAuth JSONWebTokenAuth = (HttpBearerAuth) defaultClient.getAuthentication("JSONWebTokenAuth");
    JSONWebTokenAuth.setBearerToken("BEARER TOKEN");

    ServicesApi apiInstance = new ServicesApi(defaultClient);
    ExtractFormFieldsRequest extractFormFieldsRequest = new ExtractFormFieldsRequest(); // ExtractFormFieldsRequest | 
    try {
      ExtractFormFields200Response result = apiInstance.extractFormFields(extractFormFieldsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ServicesApi#extractFormFields");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
extractFormFieldsRequest	ExtractFormFieldsRequest

Return type

ExtractFormFields200Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Form fields data	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

fillFormFields

AddWatermark201Response fillFormFields(fillFormFieldsRequest)

Fill form fields

Fills form fields in a PDF document with provided data from base64 string or a remote URL.

Example

// Import classes:
import org.pdfgeneratorapi.client.ApiClient;
import org.pdfgeneratorapi.client.ApiException;
import org.pdfgeneratorapi.client.Configuration;
import org.pdfgeneratorapi.client.auth.*;
import org.pdfgeneratorapi.client.models.*;
import org.pdfgeneratorapi.client.api.ServicesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://us1.pdfgeneratorapi.com/api/v4");
    
    // Configure HTTP bearer authorization: JSONWebTokenAuth
    HttpBearerAuth JSONWebTokenAuth = (HttpBearerAuth) defaultClient.getAuthentication("JSONWebTokenAuth");
    JSONWebTokenAuth.setBearerToken("BEARER TOKEN");

    ServicesApi apiInstance = new ServicesApi(defaultClient);
    FillFormFieldsRequest fillFormFieldsRequest = new FillFormFieldsRequest(); // FillFormFieldsRequest | 
    try {
      AddWatermark201Response result = apiInstance.fillFormFields(fillFormFieldsRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ServicesApi#fillFormFields");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
fillFormFieldsRequest	FillFormFieldsRequest

Return type

AddWatermark201Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Document data	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

optimizeDocument

OptimizeDocument201Response optimizeDocument(optimizeDocumentRequest)

Optimize document

Optimizes the size of a PDF document from base64 string or a remote URL.

Example

// Import classes:
import org.pdfgeneratorapi.client.ApiClient;
import org.pdfgeneratorapi.client.ApiException;
import org.pdfgeneratorapi.client.Configuration;
import org.pdfgeneratorapi.client.auth.*;
import org.pdfgeneratorapi.client.models.*;
import org.pdfgeneratorapi.client.api.ServicesApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://us1.pdfgeneratorapi.com/api/v4");
    
    // Configure HTTP bearer authorization: JSONWebTokenAuth
    HttpBearerAuth JSONWebTokenAuth = (HttpBearerAuth) defaultClient.getAuthentication("JSONWebTokenAuth");
    JSONWebTokenAuth.setBearerToken("BEARER TOKEN");

    ServicesApi apiInstance = new ServicesApi(defaultClient);
    OptimizeDocumentRequest optimizeDocumentRequest = new OptimizeDocumentRequest(); // OptimizeDocumentRequest | 
    try {
      OptimizeDocument201Response result = apiInstance.optimizeDocument(optimizeDocumentRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ServicesApi#optimizeDocument");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
optimizeDocumentRequest	OptimizeDocumentRequest

Return type

OptimizeDocument201Response

Authorization

JSONWebTokenAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	Document data	-
401	Unauthorized	-
402	Account Suspended	-
403	Forbidden	-
404	Not Found	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-

FilesExpand file tree

ServicesApi.md

Latest commit

History

ServicesApi.md

File metadata and controls

ServicesApi

addWatermark

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

decryptDocument

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

encryptDocument

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

extractFormFields

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

fillFormFields

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

optimizeDocument

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details