Basic Syntax of a SignDoc Mobile x-callback-url

Last updated
Save as PDF

Article # 3035584 - Page views: 128

Issue

This Article explains how to use and apply Signdoc Mobile x-callback-urls. Please note the two keywords…

keyword	description
openURLInternal	Is used to call the SignDoc Mobile app from outside - e.g. from a browser
openURLExternal	Is used to call an address outside of SignDoc Mobile from SignDoc Mobile - e.g. to call a different app or call a web address

The request url contains all information that the SignDoc Web Server needs to process a particular load document request.
It's also possible to specify complex prepare actions like inserting signature fields.

Since all Information is encoded in an url, all URLs, especially the further embedded URLs, have to be URLEncoded.
This can get complicated when it has to be done manually so it's useful to follow the step-by-step procedure below…

Solution

Single Parts of SignDoc Mobile x-callback-url

prefix: x-callback starter

signdocmobile://x-callback-url/openURLInternal?url=<url_1>

url_1: SignDoc Web Load Request

Example:
http://www.signdocweb.com/sdweb/load/doc?docurl=<url_2a_encoded>&dmsid=de.softpro.sdweb.plugins.impl.FileDms&resulturl=<url_2b_encoded>

url_2a: URL of the document (optional, not required if template or ref_id param is used in )

Example:
https://s3-eu-west-1.amazonaws.com/de.softpro.misc.testdocs/pdf/TrapezaOpenJointAccounts.pdf

url_2b: SignDoc Mobile App Result URL

Example:
signdocmobile://x-callback-url/openURLExternal?url=<url_3_encoded>

url_3: SignDoc Web Result URL (has to be URLEncoded)

Example:
http://www.google.com?q=Kofax

Info: If http:// or https:// is used, Safari opens a new tab with the link. If a different App shall be opend,
it's document handler schema has to be used e.g. myapp://

Procedure:

url_3_encoded = urlEncode(url_3)
url_2a_encoded = urlEncode(url_2a)
url_2b_encoded = urlEncode(url_2b + url_3_encoded)
url_1_encoded = urlEncode(url_1 + url_2a_encoded + url_2b_encoded)
full x-callback_url = prefix + url_1_encoded

Info: It's useful to store the intermediate encoded results in with copy & paste

Example:

url_3_encoded:

http%3A%2F%2Fwww.google.com%3Fq%3DKofax

url_2a_encoded:

https%3A%2F%2Fs3-eu-west-1.amazonaws.com%2Fde.softpro.misc.testdocs%2Fpdf%2FTrapezaOpenJointAccounts.pdf

url_2b_encoded:

signdocmobile%3A%2F%2Fx-callback-url%2FopenURLExternal%3Furl%3Dhttp%253A%252F%252Fwww.google.com%253Fq%253DKofax

url_1_encoded:

http%3A%2F%2Fwww.signdocweb.com%2Fsdweb%2Fload%2Fdoc%3Fdocurl%3Dhttps%253A%252F%252Fs3-eu-west-1.amazonaws.com%252Fde.softpro.misc.testdocs %252Fpdf%252FTrapezaOpenJointAccounts.pdf%26dmsid%3Dde.softpro.sdweb.plugins.impl.FileDms%26resulturl%3Dsigndocmobile%253A%252F%252Fx-callback-url%252 FopenURLExternal%253Furl%253Dhttp%25253A%25252F%25252Fwww.google.com%25253Fq%25253DKofax

full x-callback_url:

signdocmobile://x-callback-url/openURLInternal?rl=http%3A%2F%2Fwww.signdocweb.com%2Fsdweb%2Fload%2Fdoc%3Fdocurl%3Dhttps %253A%252F%252Fs3-eu-west-1.amazonaws.com%252Fde.softpro.misc.testdocs%252Fpdf%252FTrapezaOpenJointAccounts.pdf%26dmsid%3Dde .softpro.sdweb.plugins.impl.FileDms%26resulturl%3Dsigndocmobile%253A%252F%252Fx-callback-rl%252FopenURLExternal%253Furl%253 Dhttp%25253A%25252F%25252Fwww.google.com%25253Fq%25253DKofax

HTML code Example:

<html>
  <body>
    SignDoc Mobile x-callback-url Example<br>
    Open document in SignDoc Mobile and return to Safari and display the Google Page.<br>
    <a href="signdocmobile://x-callback-url/openURLInternal?url=http%3A%2F%2Fwww.signdocweb.com%2Fsdweb%2Fload%2Fdoc%3Fdocurl%3Dhttps%253A%252F%252Fs3- eu-west-1.amazonaws.com%252Fde.softpro.misc.testdocs%252Fpdf%252FTrapezaOpenJointAccounts.pdf%26dmsid%3Dde. softpro.sdweb.plugins.impl.FileDms%26resulturl%3Dsigndocmobile%253A%252F%252Fx-callback-url%252FopenURLExternal%253Furl%253Dhttp%25253A%25252F%25252F www.google.com%25253Fq%25253DKofax">
      open document
    </a>
  </body>
</html>

Sample scenario, document already uploaded via preload web service:

Responded redir_url http://localhost:8080/sdweb/load/doc?ref_id=1333011980416_5adc6e02-1d70-48fc-8fdf-e6333b0157d7

prefix: x-callback starter

signdocmobile://x-callback-url/openURLInternal?url=<url_1>

url_1_encoded (http://localhost:8080/sdweb/load/doc?ref_id=1333011980416_5adc6e02-1d70-48fc-8fdf-e6333b0157d7):

http%3A%2F%2Flocalhost%3A8080%2Fsdweb%2Fload%2Fdoc%3Fref_id%3D1333011980416_5adc6e02-1d70-48fc-8fdf-e6333b0157d7

full x-callback_url:

signdocmobile://x-callback-url/openURLInternal?url=http%3A%2F%2Flocalhost%3A8080%2Fsdweb%2Fload%2Fdoc%3Fref_id% 3D1333011980416_5adc6e02-1d70-48fc-8fdf-e6333b0157d7

HTML code Example

<html>
  <body>
    SignDoc Mobile x-callback-url Example<br>
    Open document in SignDoc Mobile called from an external web application.<br>
    <a href="signdocmobile://x-callback-url/openURLInternal?url=http%3A%2F%2Flocalhost%3A8080%2Fsdweb%2Fload%2Fdoc%3Fref_id%3D1333011980416_5adc6e02-1d70-48fc- 8fdf-e6333b0157d7">
      open document
    </a>
  </body>
</html>

Useful Tools

URL En/Decoder: http://meyerweb.com/eric/tools/dencoder/

Moderate

Applies to

Product	Version	Build	Environment	Hardware
SignDoc Web	All