Skip to main content
Version: 10.0

webPDF (10.0.0.3659)

Download OpenAPI specification:Download

License: SoftVision Software License Agreement

This is the REST API description for the webPDF server.

You can find out more about webPDF at https://www.webpdf.de

API authorization

The WebPDF API web service endpoints are protected and require authorization for access. The authorization is in the form of an authorization token called an "access token".

Such a token authorizes the use of the API and can be issued in two ways:

  1. the built-in authentication process using POST /authentication/user/login, which authenticates a user with credentials and issues an access token, or
  2. via an external OAuth2 provider that issues an OAuth token (a JWT based "access token") that can be validated by the server during the API call.

The server (or API) can use both paths in parallel, or individual ones can be turned on or off.

The integrated (local) authorization is available without configuration, while the use of OAuth2 tokens must first be configured in the server.

User authentication

To use local authorization, a user must be authenticated against a user source. Such a user source can be, for example, the integrated user database or an LDAP/AD server.

To authenticate use the POST /authentication/user/login call below in the Authentication group with a username and password. This will return a JSON response with access token as property token.

It is also possible to authenticate as an anonymous user by calling POST /authentication/user/login without user credentials. Note: This feature can be disabled via the configuration for the local authorization provider.

Access token (endpoint authorization)

All API calls (web service endpoints) require an access token for authorization. The access token is passed to the endpoint in the Authorization header as Bearer: [access token].

The access token can be the token provided via the local authorization provider (via POST /authentication/user/login) or an OAuth2 JWT (JSON Web Token) provided by an external authorization provider.

Omitting this header or supplying an invalid token results in an error 401 Unauthorized.

Refresh token (session renew)

When the local authorization provider issues an access token, a second token, called a refresh token, is also issued. This token is referenced as refreshToken in the JSON response when POST /authentication/user/login is used.

This token allows a new access token to be issued before the token and the associated session (see Session below) expires. With POST /authentication/user/refresh the refresh token can be 'exchanged' for a new access token and a new refresh token. This prevents the access token from expiring and terminating an active session.

Session

The REST API of this server is a stateful session based API.

Whenever an access token is issued by the local authorization provider is issued or an externally issued OAuth2 token is used with the API, a new session is created for the token.

This session retains all documents (see Document storage below) and user settings until the session expires or an explicit logout (GET /authentication/user/logout) is invoked.

Document storage

A document is uploaded to the server with POST /documents and is stored in the document storage of the server. The document storage is always assigned to a session (see "Session" above).

A unique ID documentID will be created for the uploaded file as reference. As the result of the upload the DocumentFile is fetched via 303 See Other from GET /documents/{documentId}/info. The document information DocumentFile contains the document ID in the field documentId. Most API calls in /documents/... and most call which work on documents (e.g. /converter/{documentId} or /pdfa/{documentId} ) require the ID to reference a document. The documentID can also be fetched from the list returned by GET /documents/list.

Experimental Web services

Web services marked with experimental are subject to change at any time and without notice! These web services usually provide new features that are not yet finally implemented.

Try it out (Swagger UI only)

You can call the web service API online via the documentation by pressing the 'Try it out' button for each call. For this you need an authorization in the form of an access token.

To obtain an access token, use POST /authentication/user/login, click on the "lock" icon, enter the user credentials and select "Authorize". Execute the login via the "'Try it out'" button and then via the "'Execute'" button.

Click the 'Authorize' button below and enter the access token at BearerAuth and click 'Authorize'.

Alternatively, you can enter the access token using the "lock" icon above each individual call.

authentication

Operations for user authentication

Gets information about the certificates in the user session.

Returns information about the keystores available in the user session and the certificates they contain. Certificates can be provided via user authentication (e.g. LDAP) or from the server's local file system (e.g. user or global keystores). The keystore may be locked and can be unlocked with PUT /authentication/user/certificates/passwords/....

Authorizations:
BearerAuth

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/authentication/user/certificates \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Allows updating passwords for a keystore.

Allows updating the passwords required to open a keystore and access the private keys in the user session keystore.

Authorizations:
BearerAuth
path Parameters
keyStoreName
required
string

Name of the keystore for which the passwords should be updated.

Request Body schema: application/json
required

Password information for accessing the keystore and the entries in the keystore.

object
keyStorePassword
string
Default: ""

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Gets information about a user in the session

Returns information about the user in the session.

Authorizations:
BearerAuth

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/authentication/user/info \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Authenticates a user, initiates a session and returns a authorization token Deprecated

DEPRECATED: Please use POST /authentication/user/login instead.

Authenticates a user by user name and password as a named user or as an anonymous user if both parameters are omitted. If successful, an access token is returned in the JSON response as property token. User credentials (user name and password) must be passed in HTTP header field Authorization: Basic [BASE64] or omitted for anonymous authentication.

Authorizations:
BasicAuthNone

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/authentication/user/login

Response samples

Content type
application/json
{
}

Authenticates a user, initiates a session and returns a authorization token

Authenticates a user by user name and password as a named user or as an anonymous user if both parameters are omitted. If successful, an access token is returned in the JSON response as property token. User credentials (user name and password) must be passed in HTTP header field Authorization: Basic [BASE64] or omitted for anonymous authentication.

Authorizations:
BasicAuthNone
Request Body schema: application/json

Settings for the login request

createRefreshToken
boolean
Default: false

If enabled (true), a refresh token is also created.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Logs off a user, deletes the session and all assigned tokens

Logs off the user, deletes the user session and invalidates all tokens (access and refresh token). After the call, access to the session is no longer possible. The access token is passed in as HTTP header field Authorization: Bearer [access token]. Important: You can use the locally provided access token or an OAuth2 token to end the session.

Authorizations:
BearerAuth

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/authentication/user/logout \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Updates a user session with the provided refresh token

Refreshes a user session and prevents the session from expiring. Exchanges the specified refresh token for a new set of tokens (access and refresh token). The refresh token is passed in as HTTP header field Authorization: Bearer [refresh token]. Important: Only locally provisioned refresh tokens work. Externally issued OAuth2 tokens cannot be refreshed.

Authorizations:
BearerAuth

Responses

Request samples 

curl --request POST \
  --url https://portal.webpdf.de/webPDF/rest/authentication/user/refresh \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

documents

Operations for the document storage

Uploads a document to the document storage

Uploads a document and stores it in the server´s document storage, assigning it a referencable documentID.

  • The returned document information DocumentFile contains the created ID in the field documentId.
  • The document information DocumentFile is fetched via 303 See Other from GET /documents/{documentId}/info.
Authorizations:
BearerAuth
query Parameters
history
boolean
Default: false

When set to true and whenever the document is manipulated, a history entry will be created and stored. This allows to revert such changes later.

Request Body schema: multipart/form-data
filedata
string <binary>

The document to upload, as binary data bytes.

Responses

Request samples 

curl --request POST \
  --url 'https://portal.webpdf.de/webPDF/rest/documents?history=SOME_BOOLEAN_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: multipart/form-data' \
  --form filedata=string

Response samples

Content type
application/json
{
}

Compresses the selected documents from the document storage into a new archive document.

Compresses a list of documents from the document storage selected by documentId or a file filter into a new archive document.

  • The list of documents that should be in the archive are selected via the documentId or a file filter.
  • The selection specifications can be made individually or together and act additively in the order documentId and then file filter.
  • If the id is invalid for documents selected via documentId or documents are locked, then the call is aborted with an error.
  • Depending on the storeArchive (default true) flag in the body of the request, the created archive is stored in the document storage or created as a temporary archive.
  • Depending on the accept header, the created archive itself is returned as binary data or the file information about the archive.
Authorizations:
BearerAuth
header Parameters
accept
string
Default: application/json
Example: application/json

Defines how the created archive is to be returned. If application/octet-stream is specified, the created archive is returned directly. If application/json is used (or nothing is defined), a 303 SEE OTHER with location header is used if possible, otherwise the document information is returned directly as a JSON structure.

Request Body schema: application/json
required

The settings for creating the archive document and for selecting and filtering the documents to be added to the archive.

archiveFileName
string
Default: "archive.zip"

Sets the file name for the archive document.

documentIdList
Array of strings

Sets the list of documentIds to be added to the archive document.

object (Document_FileFilter)

Defines a file filter with a list of "include" and "exclude" filter rules. First, the "include rules" are applied. If a file matches, the "exclude rules" are applied. Only if both rules apply, the file will be passed through the filter.

storeArchive
boolean
Default: false

Defines whether the archive is saved in the document storage or only created temporarily.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
{
}

Returns a list of all documents in the document storage

Returns a list of all documents currently stored in the server´s document storage.

  • Returns a DocumentFile for each document in the storage, providing further information, such as the document´s MIME type, file name, documentId, structure etc.
Authorizations:
BearerAuth

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/documents/list \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
]

Returns a list of all documents in the document storage

Returns a list of all documents currently stored in the server´s document storage.

  • Returns a DocumentFile for each document in the storage, providing further information, such as the document´s MIME type, file name, documentId, structure etc.
  • The list contains only documents that have {parentDocumentId} as parent ID
Authorizations:
BearerAuth
path Parameters
parentDocumentId
required
string

The unique documentId of the document known in the server's document storage and whose id is to be used as the parent filter for the list of documents.

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/documents/list/%7BparentDocumentId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
]

Deletes the selected document from the document storage

Deletes the document selected via it´s documentId from the server´s document storage.

  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Responses

Request samples 

curl --request DELETE \
  --url https://portal.webpdf.de/webPDF/rest/documents/%7BdocumentId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Returns the binary data of a document

Selects a document via it´s documentId and returns it as a binary data stream.

  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
  • Requires a valid session token [API token] (see Authentication at the top of document).
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document it is known by in the server´s document storage.

query Parameters
format
string (Document_StreamingFormat)
Default: "default"
Enum: "default" "html"

Directly converts the returned document into the hereby selected target format. (When set to default, the document will not be converted.)

Responses

Request samples 

curl --request GET \
  --url 'https://portal.webpdf.de/webPDF/rest/documents/%7BdocumentId%7D?format=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Updates the binary data of a document in the document store

Updates the binary data of a document in the document store referenced by the DocumentID.

If history is enabled for the document, then a new entry with the uploaded content is created.

  • The returned document information DocumentFile contains the information for the updated document.
  • The document information DocumentFile is fetched via 303 See Other from GET /documents/{documentId}/info.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Request Body schema: multipart/form-data
filedata
string <binary>

The document to upload, as binary data bytes.

Responses

Request samples 

curl --request PUT \
  --url https://portal.webpdf.de/webPDF/rest/documents/%7BdocumentId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'content-type: multipart/form-data' \
  --form filedata=string

Response samples

Content type
application/json
{
}

Returns the binary data of a file in an archive document

Selects an archive document via its documentId and returns the binary data stream for a file within the archive.

  • To select the archive document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
  • The referenced document must be an archive in a supported format
  • The archivePath must refer to a file within the archive. Wildcards are not supported.
  • Requires a valid session token [API token] (see Authentication at the top of document).
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the archive document in the server´s document storage.

archivePath
required
string.+
Example: /folder/file.txt

The file path to the file within the archive document that is to be extracted.

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/documents/%7BdocumentId%7D/archive//folder/file.txt \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Extracts the selected archive document in the document storage.

Extracts a document selected by the documentId in the document storage.

  • The document referenced by documentId must be a valid archive. If not, the operation will be aborted.
  • For each file in the archive, a new DocumentFile is created in the document storage with a new documentId.
  • Each newly created DocumentFile holds as parentDocumentId the documentId of the archive.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the archive document in the server´s document storage.

Request Body schema: application/json
required

The settings for unpacking the archive document

object (Document_FileFilter)

Defines a file filter with a list of "include" and "exclude" filter rules. First, the "include rules" are applied. If a file matches, the "exclude rules" are applied. Only if both rules apply, the file will be passed through the filter.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
[
]

Returns a list of all history entries for a selected document

Returns the list of history information HistoryEntry for the document selected via it´s documentId.

  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/documents/%7BdocumentId%7D/history \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
[
]

Returns a specific history entry for a selected document

Selects and returns a specific HistoryEntry for a document selected via it´s documentId.

  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
  • To select the HistoryEntry use the historyId of one of the HistoryEntrys returned by GET /{documentId}/history.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

historyId
required
integer <int32>

The unique historyId of the History Entry in the server´s list of history entries.

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/documents/%7BdocumentId%7D/history/%7BhistoryId%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Updates a specific history entry for a selected document

Updates the history entry with information from HistoryEntry in the request body and returns the updated entry.

  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
  • To select the HistoryEntry use the historyId of one of the HistoryEntrys returned by GET /{documentId}/history.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

historyId
required
integer <int32>

The unique historyId of the History Entry in the server´s list of history entries.

Request Body schema: application/json
required

The settings to apply to the selected history entry.

active
boolean
Default: false

When this is set to true the entry is still active and may be reverted to.

operation
string
Default: ""

The name of the operation executed for the entry. (The name of the webservice - optionally followed by ':' and the name of the executed operation.)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Returns information about an uploaded document

Returns information about the document selected by documentId in the document storage, such as it´s MIME type, file name, documentId, structure etc.

Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

query Parameters
password
string
Default: ""

An optional password. (Should a password be required to access the document.)

Responses

Request samples 

curl --request GET \
  --url 'https://portal.webpdf.de/webPDF/rest/documents/%7BdocumentId%7D/info?password=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Provides detailed information about an uploaded document

Returns information about the document selected by documentId in the document storage.

Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

details
required
string (Document_InfoType)
Default: "form"
Value: "form"

Detailed information for the document referenced by the unique documentId in the server´s document storage.

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/documents/%7BdocumentId%7D/info/%7Bdetails%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Updates the security information for a selected document

Updates the security information of a selected document in the server´s document storage, using the contained PdfPasswordType as the body request parameter and returns the updated document information. You can use this to set access passwords or other security information for a document.

  • The DocumentFile shall select the updated document via the contained documentId.
  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Request Body schema: application/json
required

The security settings to apply to the selected document.

object (Operation_KeyPair)

Allows the private key for decrypting an asymmetrically encrypted document to be handed over and the associated rights holder (recipient) to be selected by means of the certificate assigned to him. The document can only be decrypted if both are present and the private key and certificate both match and are intended for decrypting the document. When encrypting the document, it is possible to define multiple rights holders, but when decrypting the document as configured here, only a single one of these rights holders can be selected for which the decryption is to be performed.

open
string
Default: ""

A password that is required to open the document. If the provided PDF document is protected in such a way that a password (user password) is required to read the document, the corresponding password must also be passed. Without this password it is not possible to edit the document with the web service, because it cannot be read.

permission
string
Default: ""

A password that allows "editing access" to the document. If the provided PDF document is password protected and the web service operation is to edit the document, then the appropriate password (owner password) must be provided to unlock the document.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Updates the document information for a selected document

Updates the document information of a selected document in the server´s document storage, using the given DocumentFile as body request parameter and returns the updated document information. You can use this to change the file name of a document.

  • Currently only the fileName in DocumentFile can be updated.
  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Request Body schema: application/json
required

The settings to be applied to the selected document.

fileName
string
Default: ""

File name for the document (without extension)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

administration

Operations for server administration and configuration

Returns the cluster status information

Returns the the status information about the cluster and all members in the cluster.

Authorizations:
BearerAuth

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/admin/cluster/status \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Updates the server configuration

Updates andDefines an extended result object for administrative configuration operations when the configuration is updated./or validates the server, application, user or log configuration.The updated configuration is passed in the body of the request.

Authorizations:
BearerAuth
Request Body schema: application/json
required

Administration configuration

configurationType
required
string (Admin_ConfigurationType)
Default: "application"

Selects the configuration file (from installation folder conf/) that shall be processed by the configuration request.

  • application = The "application.xml"

  • server = The "server.xml"

  • user = The "users.xml"

  • log = The "log4j2.xml"

  • cluster = The "cluster.json"

  • provider = The "provider.json"

required
object (ApplicationConfig_Application)

The application element defines settings for the web services and the portal page. Some of these changes might require a server restart to take effect.

required
Array of objects (Admin_ApplicationCheck)
object (Admin_GlobalKeyStore)

Lists all contents of the keystore (e.g. it´s certificates and raw data), that shall be set as the server´s global user certificate keystore.

  • This keystore shall not be bound to a specific webservice and hence shall serve as the server´s "global" keystore file.

  • The means to provide certificates on a per user basis and in a more selective fashion, can be found in the "server.xml" user storage settings, which allow placing such certificates for a specific authenticated user, from Your LDAP or a user database instead.

  • Further settings concerning this keystore (such as it´s password and type) can be found in the application config itself. The hereby given definition is only concerned with describing and setting up the actual keystore file and it´s contained certificates.

configurationMode
required
string (Admin_ConfigurationMode)
Default: "validate"
Enum: "validate" "write"

Selects the purpose of the configuration request.

  • validate = The given configuration shall be validated.

  • write = The given configuration shall be written to the matching server configuration file.

Responses

Request samples

Content type
application/json
Example
{
}

Response samples

Content type
application/json
{
}

Gets the server configuration

Gets the server, application, user or log configuration of the server. The requested configuration is selected via `{type}.

Authorizations:
BearerAuth
path Parameters
type
required
string (Admin_ConfigurationType)
Default: "application"
Enum: "application" "server" "user" "log" "cluster" "provider"

The type of configuration to return.

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/admin/configuration/%7Btype%7D \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example
{
}

Updates a file in the datastore

Updates a file in the server's data store. The file, the file group and the settings to be updated are passed in the request body of the call.

Authorizations:
BearerAuth
Request Body schema: application/json
required

Specifies the file type and settings that should be updated for the file.

fileGroup
required
string (Admin_FileGroupDataStore)
Default: "generic"

Selects the purpose/group of a file in the server´s file data storage.

  • generic = A generic file, possibly a temporary file, without a predefined group or purpose.

  • theme = A CSS file, defining a theme for the portal page.

  • logo = An image file defining a logo for the portal page.

  • background = An image file defining a background for the portal page.

fileContent
string
Default: ""

The actual content of the data storage file

Responses

Request samples

Content type
application/json
Example
{
}

Response samples

Content type
application/json
Example
{
}

Deletes a file from the datastore

Deletes a file, depending on the selected {group}, from the server's data store. The file to delete, if {group} = generic, is referenced by the query parameter name.

Authorizations:
BearerAuth
path Parameters
group
required
string (Admin_FileGroupDataStore)
Default: "generic"
Enum: "generic" "theme" "logo" "background"

The group of datastore files to search for the file.

query Parameters
name
string
Default: ""

The name of the datastore file to delete.

Responses

Request samples 

curl --request DELETE \
  --url 'https://portal.webpdf.de/webPDF/rest/admin/datastore/%7Bgroup%7D?name=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Gets a file from the datastore

Retrieves a file, depending on the selected {group}, from the server's data store. The file name for {group} = generic is referenced by the query parameter name.

Authorizations:
BearerAuth
path Parameters
group
required
string (Admin_FileGroupDataStore)
Default: "generic"
Enum: "generic" "theme" "logo" "background"

The group of datastore files to search for the file.

query Parameters
name
string
Default: ""

The name of the datastore file to find.

Responses

Request samples 

curl --request GET \
  --url 'https://portal.webpdf.de/webPDF/rest/admin/datastore/%7Bgroup%7D?name=SOME_STRING_VALUE' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
Example
{
}

Returns the contents of a log file

Returns the contents of the current log or a specific log file of the server. If the date query parameter is specified, an explicitly selected log will be read.

Authorizations:
BearerAuth
query Parameters
date
string
Default: ""
Example: date=2019-12-01

Sets a specific date (yyyy-MM-dd) to extract from the server log.

header Parameters
Range
string
Example: 0-1024

Sets a specific byte range to extract from the server log.

Responses

Request samples 

curl --request GET \
  --url 'https://portal.webpdf.de/webPDF/rest/admin/server/log?date=2019-12-01' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN' \
  --header 'Range: 0-1024'

Response samples

Content type
application/json
{
}

Returns the byte size of a log file

Returns the byte size of the current log or a specific log file of the server. If the date query parameter is specified, an explicitly selected log will be read.

Authorizations:
BearerAuth
query Parameters
date
string
Default: ""
Example: date=2019-12-01

The date (yyyy-MM-dd) of a specific searched log.

Responses

Request samples 

curl --request HEAD \
  --url 'https://portal.webpdf.de/webPDF/rest/admin/server/log?date=2019-12-01' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Restarts the server

Restarts the server.

Authorizations:
BearerAuth

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/admin/server/restart \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Provides status information about the server

Provides status information about the server, the JVM and the Web services.

Authorizations:
BearerAuth

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/admin/server/status \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Collects a set of support information

Collects a set of support information, that may simplify finding the cause and solution of issues.

Authorizations:
BearerAuth
query Parameters
group
Array of strings (Admin_SupportEntryGroup)
Default: "logs"
Items Enum: "config" "init" "logs"
Example: group=logs&group=config

List of components to be included in the support information.

start
string
Default: ""
Example: start=2022-03-30

Start date (yyyy-MM-dd) from when the logs will be included (if logs is included in group). If empty, then current date.

end
string
Default: ""
Example: end=2022-03-31

End date (yyyy-MM-dd) until when the logs will be included (if logs is included in group). If empty, then current date.

Responses

Request samples 

curl --request GET \
  --url 'https://portal.webpdf.de/webPDF/rest/admin/server/support?group=logs&group=config&start=2022-03-30&end=2022-03-31' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Returns the session table

Returns the session table with detailed status information about each session.

Authorizations:
BearerAuth

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/admin/session/table \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

Closes the session with the specified ID

Closes the session with the specified ID, by activating the session expiration. After the call, any access to the session results in an error.

Authorizations:
BearerAuth
path Parameters
sessionId
required
string
Default: ""

ID of the session to be closed.

Responses

Request samples 

curl --request POST \
  --url https://portal.webpdf.de/webPDF/rest/admin/session/%7BsessionId%7D/close \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

converter

Operations for Web service converter

Converts a document to the PDF format

Converts a document into a PDF document. The document is selected with {documentId}.

  • After the operation is performed, the existing document will be replaced by the new created PDF document.
  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Request Body schema: application/json
required

The parameters and options for the conversion.

object (Operation_Billing)

The billing element can be used to affect the values that are written to the server's statistics logs (called "billing logs") for the web service call.

required
object (Operation_Converter)

Performs the conversion of a document.

object (Operation_PdfPassword)

The password element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected. For example, if a protected PDF document is to be edited with the web service, then these settings can be used to provide the password or certificates for access.

object (Operation_Settings)

Used to configure global settings that should be respected when running the web service operation. This concerns e.g. settings whether the execution of the operation is allowed within the scope of the PDF document settings or how the result of the operation should be handled.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

pdfa

Operations for Web service pdfa

Converts a PDF document to the PDF/A format

Converts a PDF document into a PDF/A document. The document is selected with {documentId}.

  • After the operation is performed, the existing document will be replaced by the updated document.
  • Be aware that the document must conform to the intended PDF/A conformance level, otherwise the conversion should be expected to fail.
  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Request Body schema: application/json
required

The parameters and options for the PDF/A conversion.

object (Operation_Billing)

The billing element can be used to affect the values that are written to the server's statistics logs (called "billing logs") for the web service call.

object (Operation_PdfPassword)

The password element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected. For example, if a protected PDF document is to be edited with the web service, then these settings can be used to provide the password or certificates for access.

required
object (Operation_Pdfa)

When using the "Pdfa" web service, both the <convert> and <analyze> operations can be used.

The convert operation is used to convert PDF documents to PDF/A, while the analyze operation is used to validate existing PDF/A documents.

object (Operation_Settings)

Used to configure global settings that should be respected when running the web service operation. This concerns e.g. settings whether the execution of the operation is allowed within the scope of the PDF document settings or how the result of the operation should be handled.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

ocr

Operations for Web service ocr

Executes OCR and adds a text layer to the document

Executes OCR operations for images and PDF documents. Should the document already be a PDF document, a text layer is added to pages of the document not containing text. Otherwise the document is converted to a PDF document first, to apply an OCR text layer then. The document is selected with {documentId}.

  • After the operation is performed, the existing document will be replaced by the updated document.
  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Request Body schema: application/json
required

The parameters and options for the OCR operation.

object (Operation_Billing)

The billing element can be used to affect the values that are written to the server's statistics logs (called "billing logs") for the web service call.

required
object (Operation_Ocr)

The "OCR" web service can be used to run character recognition in PDF documents or images. If recognition is run on images, they will be converted to PDF documents. More specifically, a page will be generated for each image in the PDF document, with this page containing the original image and a text layer with the recognized text. Character recognition on PDF documents will only work with documents that do not contain text already. Normally, these will be documents that were generated by scanners and that only have an image per page in the PDF document.

object (Operation_PdfPassword)

The password element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected. For example, if a protected PDF document is to be edited with the web service, then these settings can be used to provide the password or certificates for access.

object (Operation_Settings)

Used to configure global settings that should be respected when running the web service operation. This concerns e.g. settings whether the execution of the operation is allowed within the scope of the PDF document settings or how the result of the operation should be handled.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

signature

Operations for Web service signature

Digitally signs a PDF document.

Digitally signs a PDF document. The document is selected with {documentId}.

  • After the operation is performed, the existing document will be replaced by the updated document.
  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Request Body schema: application/json
required

The parameters and options for the signature operation.

object (Operation_Billing)

The billing element can be used to affect the values that are written to the server's statistics logs (called "billing logs") for the web service call.

object (Operation_PdfPassword)

The password element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected. For example, if a protected PDF document is to be edited with the web service, then these settings can be used to provide the password or certificates for access.

object (Operation_Settings)

Used to configure global settings that should be respected when running the web service operation. This concerns e.g. settings whether the execution of the operation is allowed within the scope of the PDF document settings or how the result of the operation should be handled.

required
object (Operation_Signature)

The "Signature" web service can be used to digitally sign documents or to remove all signatures from a PDF documents.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

toolbox

Operations for Web service toolbox

Creates an empty document and applies toolbox operations

Provides a number of different operations that can be used to edit the newly created PDF document.

  • Which toolbox operations are executed is selected in the given parameters.
  • You can find information about the created document (such as it´s documentId in the server´s document storage) in the hereby returned DocumentFile.
Authorizations:
BearerAuth
query Parameters
history
boolean
Default: false

When set to true and whenever the document is manipulated, a history entry will be created and stored. This allows to revert such changes later.

name
string
Default: "empty.pdf"

Set the name for the newly created document

Request Body schema: application/json
required

The parameters and options for the toolbox operation.

object (Operation_Billing)

The billing element can be used to affect the values that are written to the server's statistics logs (called "billing logs") for the web service call.

object (Operation_PdfPassword)

The password element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected. For example, if a protected PDF document is to be edited with the web service, then these settings can be used to provide the password or certificates for access.

object (Operation_Settings)

Used to configure global settings that should be respected when running the web service operation. This concerns e.g. settings whether the execution of the operation is allowed within the scope of the PDF document settings or how the result of the operation should be handled.

Array of Operation_ToolboxAnnotation (object) or Operation_ToolboxAttachment (object) or Operation_ToolboxDelete (object) or Operation_ToolboxDescription (object) or Operation_ToolboxExtraction (object) or Operation_ToolboxForms (object) or Operation_ToolboxImage (object) or Operation_ToolboxMerge (object) or Operation_ToolboxMove (object) or Operation_ToolboxOptions (object) or Operation_ToolboxPrint (object) or Operation_ToolboxRotate (object) or Operation_ToolboxSecurity (object) or Operation_ToolboxSplit (object) or Operation_ToolboxWatermark (object) or Operation_ToolboxXmp (object) or Operation_ToolboxOutline (object) or Operation_ToolboxRedact (object) or Operation_ToolboxPortfolio (object) or Operation_ToolboxScale (object) or Operation_ToolboxCompress (object) or Operation_ToolboxTranscribe (object) (Operation_BaseToolbox)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Provides a set of different operations to modify PDF documents

Provides a set of different operations to modify existing PDF documents. The document is selected with {documentId}.

  • After the operation is performed, the existing document will be replaced by the updated document.
  • Which toolbox operations are executed is selected in the given parameters.
  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Request Body schema: application/json
required

The parameters and options for the toolbox operation.

object (Operation_Billing)

The billing element can be used to affect the values that are written to the server's statistics logs (called "billing logs") for the web service call.

object (Operation_PdfPassword)

The password element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected. For example, if a protected PDF document is to be edited with the web service, then these settings can be used to provide the password or certificates for access.

object (Operation_Settings)

Used to configure global settings that should be respected when running the web service operation. This concerns e.g. settings whether the execution of the operation is allowed within the scope of the PDF document settings or how the result of the operation should be handled.

Array of Operation_ToolboxAnnotation (object) or Operation_ToolboxAttachment (object) or Operation_ToolboxDelete (object) or Operation_ToolboxDescription (object) or Operation_ToolboxExtraction (object) or Operation_ToolboxForms (object) or Operation_ToolboxImage (object) or Operation_ToolboxMerge (object) or Operation_ToolboxMove (object) or Operation_ToolboxOptions (object) or Operation_ToolboxPrint (object) or Operation_ToolboxRotate (object) or Operation_ToolboxSecurity (object) or Operation_ToolboxSplit (object) or Operation_ToolboxWatermark (object) or Operation_ToolboxXmp (object) or Operation_ToolboxOutline (object) or Operation_ToolboxRedact (object) or Operation_ToolboxPortfolio (object) or Operation_ToolboxScale (object) or Operation_ToolboxCompress (object) or Operation_ToolboxTranscribe (object) (Operation_BaseToolbox)

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

urlconverter

Operations for Web service urlconverter

Creates a PDF document from the content of an URL

Loads the contents of a URL and converts the content into a new PDF document.

  • You can find information about the created document (such as it´s documentId in the server´s document storage) in the hereby returned DocumentFile.
Authorizations:
BearerAuth
query Parameters
history
boolean
Default: false

When set to true and whenever the document is manipulated, a history entry will be created and stored. This allows to revert such changes later.

Request Body schema: application/json
required

The parameters and options for the URL conversion.

object (Operation_Billing)

The billing element can be used to affect the values that are written to the server's statistics logs (called "billing logs") for the web service call.

object (Operation_PdfPassword)

The password element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected. For example, if a protected PDF document is to be edited with the web service, then these settings can be used to provide the password or certificates for access.

object (Operation_Settings)

Used to configure global settings that should be respected when running the web service operation. This concerns e.g. settings whether the execution of the operation is allowed within the scope of the PDF document settings or how the result of the operation should be handled.

required
object (Operation_UrlConverter)

The "URLConverter" web service van be used to convert URL resources (websites) to a PDF document.

Important: Please keep the limitations of HTML conversion in mind (see chapter "HTML conversion").

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

barcode

Operations for Web service barcode

Creates a new PDF or image containing a barcode

Creates a new PDF or image file containing a barcode as it´s only content.

  • You can find information about the created document (such as it´s documentId in the server´s document storage) in the hereby returned DocumentFile.
Authorizations:
BearerAuth
query Parameters
history
boolean
Default: false

When set to true and whenever the document is manipulated, a history entry will be created and stored. This allows to revert such changes later.

name
string
Default: "empty.pdf"

Set the name for the newly created barcode document.

Request Body schema: application/json
required

The parameters and options for the barcode operation.

required
object (Operation_Barcode)

The "Barcode" web service can be used to generate and recognize barcodes in PDF documents. The <add> element is used to add barcodes, while the <detect> element is used to read existing barcodes.

object (Operation_Billing)

The billing element can be used to affect the values that are written to the server's statistics logs (called "billing logs") for the web service call.

object (Operation_PdfPassword)

The password element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected. For example, if a protected PDF document is to be edited with the web service, then these settings can be used to provide the password or certificates for access.

object (Operation_Settings)

Used to configure global settings that should be respected when running the web service operation. This concerns e.g. settings whether the execution of the operation is allowed within the scope of the PDF document settings or how the result of the operation should be handled.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

Adds barcodes or recognizes barcodes in PDF documents

Adds a barcode to a PDF or detects a barcode in a PDF document or image file. The document is selected with {documentId}.

  • After the operation is performed, the existing document will be replaced by the updated document.
  • To select the document use the documentId returned, when uploading the document to the server´s document storage, or select a documentId of one of the documents returned by GET /documents/list.
Authorizations:
BearerAuth
path Parameters
documentId
required
string

The unique documentId of the document in the server´s document storage.

Request Body schema: application/json
required

The parameters and options for the barcode operation.

required
object (Operation_Barcode)

The "Barcode" web service can be used to generate and recognize barcodes in PDF documents. The <add> element is used to add barcodes, while the <detect> element is used to read existing barcodes.

object (Operation_Billing)

The billing element can be used to affect the values that are written to the server's statistics logs (called "billing logs") for the web service call.

object (Operation_PdfPassword)

The password element can be used to set the user and owner passwords or certificates for the PDF document which are needed if the PDF document is protected. For example, if a protected PDF document is to be edited with the web service, then these settings can be used to provide the password or certificates for access.

object (Operation_Settings)

Used to configure global settings that should be respected when running the web service operation. This concerns e.g. settings whether the execution of the operation is allowed within the scope of the PDF document settings or how the result of the operation should be handled.

Responses

Request samples

Content type
application/json
{
}

Response samples

Content type
application/json
{
}

portal

Important: Web services in this area are intended for usage of the portal application only and may change at any time without notice!

Gets the portal information [Internal use only, will change without further notice]

Gets the portal information. These information are for internal use only, they are undocumented and will change without further notice!

Responses

Request samples 

curl --request GET \
  --url https://portal.webpdf.de/webPDF/rest/portal/info

Response samples

Content type
application/json
{
}

experimental

Important: Web services in this area are currently experimental and may change at any time without notice!

Reads statistic information (Experimental Web service)

Reads statistic information from the server for Web services and file formats. (Experimental Web service)

Authorizations:
BearerAuth
path Parameters
dataSource
required
string (Admin_DataSourceServerState)
Default: "realtime"
Enum: "realtime" "persistent"

Data source from which the data is read.

aggregation
required
string (Admin_AggregationServerState)
Default: "hour"
Enum: "minute" "hour" "day" "month" "year"

Aggregation mode for the retrieved data.

query Parameters
webservice
Array of strings (Webservice)
Items Enum: "signature" "pdfa" "toolbox" "converter" "urlconverter" "ocr" "barcode"

List of webservice names from which the data should be retrieved.

start
string
Default: ""
Example: start=2022-01-20T12:30:00,000Z

Start date for the data, formatted as ISO-8601 extended offset (zoned based) date-time format.

end
string
Default: ""
Example: end=2022-01-22T23:59:59,000Z

End date for the data, formatted as ISO-8601 extended offset (zoned based) date-time format.

Responses

Request samples 

curl --request GET \
  --url 'https://portal.webpdf.de/webPDF/rest/admin/statistic/%7BdataSource%7D/%7Baggregation%7D?webservice=SOME_ARRAY_VALUE&start=2022-01-20T12%3A30%3A00%2C000Z&end=2022-01-22T23%3A59%3A59%2C000Z' \
  --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'

Response samples

Content type
application/json
{
}

We use cookies to personalize content and ads, to provide social media features, and to analyze traffic to our website. We also share information about your use of our website with our social media, advertising and analytics partners. Our partners may combine this information with other information that you have provided to them or that they have collected as part of your use of the services. Further information in the privacy policy