sign pro PDF Version 4

API

The sign pro PDF Application Programming Interface allows the application to be started with a set of parameters to determine its operation. To use this feature the sign pro PDF license must include "SIGNPRO_API_ACCESS" rights.

The parameters include:

  • Input/output files
  • Configuration of the application (e.g. optional display of menus)
  • Input field creation (e.g. signature and text fields)

The parameters are supplied in a JSON structure and the PDF document to be processed can be supplied with or without pre-prepared field information. That is, fields can be created at runtime using JSON commands (API mode), or can be identified using text in the PDF document itself (Text tag mode).

To demonstrate the API a demo program is supplied with samples along with the reference documents:

Downloads

DownloadDescription
API GuideDescribes using the demonstration and samples
API SpecificationReference for the API syntax
Demo AppZip file containing demo app and samples

FAQs

Error starting API

To use the API functionality the sign pro PDF license must be set to Evaluation or Enterprise to include "SIGNPRO_API_ACCESS". If this is not enabled an error message will be displayed: ‘API access prohibited’.

Invalid JSON

Before attempting to start sign pro PDF the test validates the JSON structure. An error message will be displayed in the Status window, for example a missing a comma: Validating JSON... After parsing a value an unexpected character was encountered: ". Path 'file', line 17, position 2. Invalid Json The structure must be corrected before attempting to submit.

Error message displayed by sign pro PDF

If the API commands cannot be processed an error message will be displayed. Check the content of the JSON structure and/or the text tags, particularly file paths and references to page numbers.

The JSON structure can be validated online, for example here: https://jsonformatter.curiousconcept.com/

← User GuidesContents →