Versions Compared

Old Version 24

changes.mady.by.user Manuel Gierlinger

Saved on

compared with

New Version 25

changes.mady.by.user Manuel Gierlinger

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
languagejava
themeEclipse
{
    "Documents": [
        {
            "FileId": "8a4fd938-1234-1234-842a-be1e1d472b1c",
            "DocumentNumber": 1
        }
    ],
    "Name": "Test",

    "Activities": [
        
        {
        
            "Action": {
                "Sign": {
                    "RecipientConfiguration": {
                        "ContactInformation": {
                            "Email": "janedoe@sample.com",
                            "GivenName": "Jane",
                            "Surname": "Doe"
                        }
                    },
                    "Elements": {
                        "Signatures": [
                            {
                                "TaskConfiguration": {
                                    "OrderDefinition": {
                                        "OrderIndex": 1
                                    }
                                },
                                "ElementId": "sample sig click2sign",
                                "Required": true,
                                "DocumentNumber": 1,
                                "DisplayName": "Sign here",
                                "AllowedSignatureTypes": {
                                    "ClickToSign": {}
                                },
                                "FieldDefinition": {
                                    "Position": {
                                        "PageNumber": 1,
                                        "X": 100,
                                        "Y": 200
                                    },
                                    "Size": {
                                        "Width": 100,
                                        "Height": 70
                                    }
                                }
                            }
                        ]
                    },
                    "SigningGroup": "firstSigner"
                }
            }
        },
        {
            "Action": {
                "SendCopy": {
                    "RecipientConfiguration": {
                        "ContactInformation": {
                            "Email": "johndoe@sample.com",
                            "GivenName": "John",
                            "Surname": "Doe"
                        }
                    }
                }
            }
        }
    ]
}

Open the envelope

 After you have sent the envelope and you have got the envelopeId you can call the method https://demo.esignanywhere.net/api/v6/envelope/{envelopeId}/viewerlinks.  With the result of this method you get information about the envelope and you can find the workstepRedirectionURL (Viewerlink).

Image Added

FigureDescription

Image Added

Steps:

  1. Set the request type to GET
  2. Set the URI: https://demo.esignanywhere.net/api/v6/envelope/{envelopeId}/viewerlinks
  3. Add the authentication (Api Token) in the header

Response

Code Block
languagejava
themeEclipse
{
    "ViewerLinks": [
        {
            "ActivityId": "5609d2ea-1234-1234-1234-1959e63fde64",
            "Email": "john.doe@sample.com",
            "ViewerLink": "https://demo.esignanywhere.net/workstepredirector/sign?identifier=mdIkzVC1234512IgiOLD3Iodfynd~12345RbJQXusyZuCNp7FR6PniOT12345B~fQ1234A=="
        }
    ]
}

With this redirection link it is possible to open and sign the document in your web portal.

Download the signed document

Before downloading the documents we need the file Ids. Therefore the following api call is necessary:

FigureDescription


Steps:

  1. Set the request type to GET
  2. Set the URI: https://demo.esignanywhere.net/Api/v6/envelope/{envelopeId}/files
  3. Add the authentication (Api Token) in the header

Response

Code Block
languagejava
themeEclipse
{
    "Documents": [
        {
            "FileId": "78b271f2-1234-1234-1234-3799951b1d54",
            "FileName": "Test.pdf",
            "Attachments": [],
            "PageCount": 1,
            "DocumentNumber": 1
        }
    ],
    "AuditTrail": {
        "FileId": "7a86456c-1234-1234-1234-032757afa88e",
        "XmlFileId": "dc60dcd4-1234-1234-1234-8828c79a2c88"
    },
    "Disclaimers": []
}

Here you can see all three Ids for the documents which can be downloaded.

After this call just add the Ids in the following api call URI and download the documents:

FigureDescription

Steps:

  1. Set the request type to GET
  2. Set the URI: https://demo.esignanywhere.net/Api/v6/file/{fileId}
  3. Add the authentication (Api Token) in the header

Response


Document to download


How to use variables in Postman

...