The web API can be used to access the comparison feature of the i-net PDFC server in a micro service kind of way, e.g. for a cloud based application. The following setup is required for a common micro service:

• Create a user account that will create, run and publish the comparisons. This account requires the following permissions:
  • Web API access
  • Modify and run comparisons
  • Publish comparisons
• Create a second user account to view the comparisons. For this purpose the account only requires the permission Comparison GUI. It is recommended to use the guest account as viewer account. This account will not prompt for an authentication.

The /compare command can be used to create and run a comparison. The result type of the command has to be the default one which is the comparison ID.

Once the comparison ID is retrieved, use it to temporarily publish the comparison:

# temporarily publish
http://127.0.0.1:9900/api/comparison/TG9yZW0gaXBzdW0gZG9sb3Igc2l0IG1ldC4/publish?onetime=true

A published comparison can be viewed by directing the viewer user to it:

# enter in browser
http://127.0.0.1:9900/public/comparison/TG9yZW0gaXBzdW0gZG9sb3Igc2l0IG1ldC4/

Note: Since the comparison is published using onetime it will automatically be deleted as soon as there are no more viewers registered to this comparison.