Creating a Designer Session
  • 10 Oct 2024
  • 2 Minutes to read
  • Dark
    Light
  • PDF

Creating a Designer Session

  • Dark
    Light
  • PDF

Article summary

Java SDK.NET SDKREST APIAPEX SDK

Java SDK

To download the full code sample see our Code Share site.

The Designer page enables you to view each document, to add signatures and other fields to it, and to assign permissions to documents.

You can only open a designer session for a transaction with a DRAFT status.

Creating a Designer Session

To begin, use the AuthenticationTokensService to create a signer authentication token using the packageid. The following code will do this:

Note that user authentication tokens are single use and expire after 30 minutes.

String senderAuthenticationToken = client.getAuthenticationTokensService().createSenderAuthenticationToken(packageId);

Then, using the user authentication token you just created and the package id returned to you during package creation process, build the following URL:

https://sandbox.esignlive.com/auth?senderAuthenticationToken={senderToken}&target=https://sandbox.esignlive.com/a/transaction/{packageId}/designer

Results

Here is an example of what you can expect to see once you have run your code.

.NET SDK

To download the full code sample see our Code Share site.

The Designer page enables you to view each document, to add signatures and other fields to it, and to assign permissions to documents.

You can only open a designer session for a transaction with a DRAFT status.

Creating a Designer Session

To begin, use the AuthenticationTokensService to create a signer authentication token using the packageid. The following code will do this:

Note that user authentication tokens are single use and expire after 30 minutes.

string senderAuthenticationToken = client.AuthenticationTokenService.CreateSenderAuthenticationToken(packageId);

Then, using the user authentication token you just created and the package id returned to you during package creation process, build the following URL:

https://sandbox.esignlive.com/auth?senderAuthenticationToken={senderToken}&target=https://sandbox.esignlive.com/a/transaction/{packageId}/designer

Results

Here is an example of what you can expect to see once you have run your code.

REST API

To download the full code sample see our Code Share site.

The Designer page enables you to view each document, to add signatures and other fields to it, and to assign permissions to documents.

You can only open a designer session for a transaction with a DRAFT status.

The first step is to create a sender authentication token. The following code will do this:

HTTP Request

POST /api/authenticationTokens/sender

HTTP Headers

Accept: application/json
Content-Type: application/json
Authorization: Basic api_key

Request Payload

{
  "packageId": "e937fc75-3c3b-4506-b270-cc7e43f4cf78"
}

Response Payload

{
   "value": "MjY0MjQ4MzgtMTJlOS00MzhjLTgzODMtMzJmMGNiZTg3ODBl"
}

Then, you will need to parse the response in order to retrieve the user authentication token.

Note that user authentication tokens are single use and will expire after 30 minutes.

Using the authentication token you just created and the package id returned to you during package creation, build the following URL:

https://sandbox.esignlive.com/auth?senderAuthenticationToken={senderToken}&target=https://sandbox.esignlive.com/a/transaction/{packageId}/designer

Results

Here is an example of what you can expect to see once you have run your code.

APEX SDK

To download the full code sample see our Code Share site.

The Designer page enables you to view each document, to add signatures and other fields to it, and to assign permissions to documents.

You can only open a designer session for a transaction with a DRAFT status.

To begin, create a sender authentication token using the following encapsulated function:

Note that user authentication tokens are single use and expire after 30 minutes.

public String createSenderAuthenticationToken(String packageId)

Then, using the user authentication token you just created and the package id returned to you during package creation process, build the following URL:

public String buildRedirectToDesignerForUserAuthenticationTokenNew(String senderAuthenticationToken, String packageId)

Results

Here is an example of what you can expect to see once you have run your code.


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Ozzy, our interactive help assistant