Create a diff URL

With this API call you can create a difference view link for the PROOFSCOPE viewer.

api.proofscope.create_view_file_difference_url_with_options(host_url, file_url, diff_url, options)

Parameters:
  • host_url: the public host URL where CLOUDFLOW is accessible (for example http://my.company.com/)
  • file_url: the CLOUDFLOW URL of the asset to view (for example cloudflow://PP_FILE_STORE/Demo%20Files/packaging_crab_orig.pdf).
  • diff_url: the CLOUDFLOW URL of the asset to diff with (for example cloudflow://PP_FILE_STORE/Demo%20Files/packaging_crab_corrected.pdf).
  • options: a JSON dictionary with optional parameters.
    • email: the email of the user that will view the file.
    • time_out: the amount of seconds the link should be available, by default 14 days.
Note: This call just returns an URL, it doesn't send an email to the user. If the contact doesn't exist, it will be created on the fly.

Example

If you want to view the difference between the files cloudflow://PP_FILE_STORE/Demo%20Files/packaging_crab_orig.pdf and cloudflow://PP_FILE_STORE/Demo%20Files/packaging_crab_corrected.pdf

the API call:

api.proofscope.create_view_file_difference_url_with_options(
 "http://localhost:9090", 
 "cloudflow://PP_FILE_STORE/Demo%20Files/packaging_crab_orig.pdf", 
 "cloudflow://PP_FILE_STORE/Demo%20Files/packaging_crab_corrected.pdf", {
  email: "john@domain.com"
})
returns: 
{
 result: "ok",
 url: "http://localhost:9090/portal.cgi?proofscope&asset_id=553a171ce7c40000000004e0&email=john%40domain.com&temp_scope=9d15496c-4651-4916-b56d-d340b39f6961&view_id=41d768b7-94cd-4aa6-9356-c558cbf5555e&signature=affb1cba796f20c0243e174c24707404"
}