Signi API Call Examples

1 "Hello World" Example 1 - Gathering the information about workspace
- 1.1 End Point Description
- 1.2 End Point Call
- 1.3 End Point Result
2 "Hello World" Example 2 - Issuing the PDF file for the Signature
- 2.1 End Point Description
- 2.2 End Point Call
- 2.3 End Point JSON File with Parameters
- 2.4 End Point Result
- 2.5 Final Document Example
3 “Hello World” Example 3 - Issuing the Data Into the Template in Signi
- 3.1 End Point Description
- 3.2 End Point Call
- 3.3 End Point JSON Parameters
- 3.4 Final Document Example

"Hello World" Example 1 - Gathering the information about workspace

There is a workspace "Demo API" with the API key “71c4123d242bdd38047bee838d17e3367dc3ea6748d0975217ce501e834a224c83cab8afd35c9b0e6ade806b7987fae80f97f5c8253cfbb9089cf21f” and Signi production environment https://api.signi.com. Use the API key of your workspace for your calls.

End Point Description

Authorization > User Detail

End Point Call

Request - GET
Address - https://api.signi.com/api/v1/me .
Autorization - Type: API Key , Placement in: Header, variable name: x-api-key , value: see API key above.

End Point Result

{
    "user": {
        "email": "aplikace@signi.com"
    },
    "workspace": {
        "name": "iSmlouva marketing"
    },
    "token": {
        "expiration_date": "2030-08-07"
    },
    "links": {
        "tokens": "https://app.ismlouva.cz/api"
    }
}

"Hello World" Example 2 - Issuing the PDF file for the Signature

There is a workspace "Demo API" with the API key “71c4123d242bdd38047bee838d17e3367dc3ea6748d0975217ce501e834a224c83cab8afd35c9b0e6ade806b7987fae80f97f5c8253cfbb9089cf21f” and Signi production environment https://api.signi.com . Use the API key of your workspace for your calls.

End Point Description

Document Creation > From File

End Point Call

Request - POST
Address - https://api.signi.com/api/v1/contract/ , with parameter Type with the value “doc”.
Autorization - Type: API Key , Placement in: Header, variable name: x-api-key , value: see API key above.
Body - type request multipart/form-data and two keys- data a uploaded_file_key of File type . The first contains the JSON file with end point parameter the second one is PDF file to be signed.

Section Params

Section Autorization

Section Body

The keys in the Points section are of type "File", the file to be sent in the request is selected from your disk
and uploaded via "Select Files"

End Point JSON File with Parameters

JSON for download

{
    "name": "irrelevant",
    "number": "irrelevant",
    "locale": "cs",
    "settings": {
        "signing_order": "all_at_once",
        "autosign_proposers": "V Praze",
        "missing_positions": "append_to_the_end"
    },
    "people": [
        {
            "is_proposer": true,
            "email": "aplikace@signi.com",
            "first_name": "Johny",
            "last_name": "Doe#1",
            "contract_role": "sign"
        },
        {
            "is_proposer": false,
            "email": "roman.ripa+20210341@signi.com",
            "contract_role": "sign",
            "person_type": "nature",
            "first_name": "John",
            "last_name": "Doe#2"
        }
    ],
    "file": "uploaded_file_key"
}

Yes, we know, such parameter passing is not a pure REST API, we will improve the API in future versions.

End Point Result

It contains:

contract_id - unique identification of the document useful for future calls regarding this document
the URLs for signing the documents by each signer.

Final Document Example

“Hello World” Example 3 - Issuing the Data Into the Template in Signi

There is a workspace "Demo API" with the API key “71c4123d242bdd38047bee838d17e3367dc3ea6748d0975217ce501e834a224c83cab8afd35c9b0e6ade806b7987fae80f97f5c8253cfbb9089cf21f” and Signi production environment https://api.signi.com . Use the API key of your workspace for your calls.
The proposer of the document is demo@signi.com . The signing counterparty is protistrana@firma.cz , you can change it to your e-mail to test the signing . The order of signing is set to proposers_before_counterparties i.e. the proposer signs the first (automatically in this case) and couterparty afterwards.
There is used the template Testovací smlouva with the ID template 7v1 and several parameters with ID 12, 131, 411, 421, 431 .

End Point Description

Document Creation > From Template

End Point Call

Request - POST
Address - https://api.signi.com/api/v1/contract/ , with parameter Type with the value “template”.
Autorization - Type: API Key , Placement in: Header, variable name: x-api-key , value: see API key above.
Body - type request multipart/form-data and one key - data of File type . It contains the JSON file with end point parameter.

The keys in the Points section are of type "File", the file to be sent in the request is selected from your disk
and uploaded via "Select Files"

End Point JSON Parameters

JSON for download

{
    "settings": {
      "signing_order": "proposers_before_counterparties",
      "autosign_proposers": "V Praze"
    },
    "people": [
      {
        "is_proposer": true,
        "email": "demo@signi.com",
        "contract_role": "sign"
      },
      {
        "is_proposer": false,
        "party_order": 1,
        "email": "protistrana@firma.cz",
        "contract_role": "sign"
      }
    ],
    "template": {
        "id": "7v1",
        "parameters": [
          {
            "id": "112",
            "value": "Hnutí za digitalní revoluci"
          },
          {
            "id": "131",
            "value": "Chci"
          },
          {
            "id": "411",
            "value": "V šíření zpráv"
          },
          {
            "id": "421",
            "value": "27.5.2021"
          },
          {
            "id": "431",
            "value": "v Praze"
          }
        ]
    }
  }

Final Document Example

An invitation to sign the document is sent to the user with the email counterparty@company.com.