Příklady volání Signi API

{
    "contract_name": "Navrhovatel schvaluje automaticky, protistrana kvalifikovaný podpis, podpisy přes placeholdery, použijte Signi API - Testovací dokument - Placehodery 2.pdf",
    "number": "document number - 000001",
    "state": "pending",
    "locale": "cs",
    "settings": {
        "signing_order": "proposers_before_counterparties",
        "autosign_proposers": "V Praze"
    },
    "people": [
        {
            "is_proposer": true,
            "email": "demo@signi.com",
            "contract_role": "approve",
                  "positions": [
              {
                "anchor": "signi-signature-0"
              } 
            ]
  },
        {
            "is_proposer": false,
            "email": "demo+protistrana-neregistrovana01@signi.com",
            "contract_role": "sign_certificate",
      "person_type": "nature",
            "first_name": "John",
            "last_name": "Doe#2",

            "positions": [
              {
                "anchor": "signi-signature-2"
              } 
            ]

        }
    ],
    "file": "uploaded_file_key"
}

Příklad 3 - Předání podkladů pro vzor 

A - Předání běžných hodnot - text, číslo, datum 

• Na produkčním prostředí Signi https://api.signi.com je workspace "Demo API" a má API klíč = “71c4123d242bdd38047bee838d17e3367dc3ea6748d0975217ce501e834a224c83cab8afd35c9b0e6ade806b7987fae80f97f5c8253cfbb9089cf21f”, Při svých voláních zaměňte tento API klíč za API klíč svého workspace, který získáte po objednání služby "Integrace API" a Generování API klíče.

• Pro předání údajů pro vzor dokumentu v Signi se využije end point Vytvoření smlouvy 2.0 > Ze vzoru.

• Za navrhovatele automaticky podepisuje účet demo@signi.com, tvůrce workspace.. Z protistranu v příkladu podepisuje protistrana@firma.cz, změňte při testování na svůj e-mail. Je nastaveno pořadí podepisování proposers_before_counterparties to jest, nejdříve se vloží podpis navrhovatele a pak odchází výzva k podpisu protistraně.

• Volá se vzor Testovací smlouva s ID vzoru 7v1 s několika parametry, jejichž ID jsou 112, 131, 411, 421, 431. Parametry jiných vzorů snadno zjistíte, viz Jak při použití vzorů zjistit, které parametry vzor má?

Popis v dokumentaci

• Vytvoření smlouvy 2.0 > Ze vzoru

Volání v Postmanovi

• Požadavek je typu POST.

• Adresa je https://api.signi.com/api/v1/contract/, na záložce Param je zadán parametr Type s hodnotou ”template” tj. výsledná adresa je volání je https://api.signi.com/api/v1/contract/?type=template.

• Na záložce Autorization je jako typ autorizace zvolen jako typ autorizace API Key a jako hodnota klíče x-api-key je uveden API klíč workspace a umístění API klíče je zvoleno Header.

• Na záložce Body je jako typ volání zvoleno multipart/form-data a je uveden jeden klíč - data se souborem JSON, v kterém jsou parametry volání endpointu

Klíče na záložce Body jsou typu “File”, soubor k zaslání v požadavku se vybere z vašeho disku a nahraje přes “Select Files”.

JSON soubor s podpisovým scénářem

• JSON soubory ke stažení
  
  

{
  "contract_name":"Testovací smlouva 2022",
  "number": "000001",
  "locale": "cs",
  "settings": {
    "signing_order": "proposers_before_counterparties",
    "autosign_proposers": "V Praze"
  },
  "people": [
    {
      "is_proposer": true,
      "email": "demo@signi.com",
      "contract_role": "sign"
    },
    {
      "is_proposer": false,
      "email": "demo+API@signi.com",
      "contract_role": "sign",
      "person_type": "nature",
      "first_name": "John",
      "last_name": "Doe´"
    }
  ],
  "template": {
      "id": "7v1",
      "parameters": [
        {
          "id": "112",
          "value": "Hnutí za digitalní revoluci"
        },
        {
          "id": "122",
          "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"
        },
        {
          "id": "5",
          "value": "true"
        }
      ]
  }
}

B - Předávání hodnoty z výčtu hodnot 

• Parametr 221 typu výběr variant (ve vzoru <con-options>) má dvě možné hodnoty (ve vzoru <con-option... label="..."...>) : “Příjemce není osobou povinnou ke zveřejnění smlouvy v registru smluv nebo výše plnění nedosahuje zákonného limitu pro zveřejnění v registru” a “Příjemce je osobou povinnou ke zveřejnění smlouvy v registru smluv a výše plnění dosahuje zákonného limitu pro zveřejnění v registru”

• Pří předávání parametru 221 se pak předává název konkrétní hodnoty z výčtu hodnot.

Příklad kódu vzoru

<con-section con-id="22">
            <con-options con-id="221" bind="selection-221" name="" description="" placeholder="vyberte">
                <con-option con-id="2211" label="Příjemce není osobou povinnou ke zveřejnění smlouvy v registru smluv nebo výše plnění nedosahuje zákonného limitu pro zveřejnění v registru">
                    <p class="odsazeni"><span>V.2</span>Tato Smlouva nabývá účinnosti okamžikem jejího podpisu oběma Smluvními stranami.</p>
                </con-option>
                <con-option con-id="2212" label="Příjemce je osobou povinnou ke zveřejnění smlouvy v registru smluv a výše plnění dosahuje zákonného limitu pro zveřejnění v registru">
                    <p class="odsazeni"><span>V.2</span>Smluvní strany berou na vědomí, že tato Smlouva ke své účinnosti vyžaduje uveřejnění v registru smluv podle zákona č. 340/2015 Sb., zákon o registru smluv a s tímto uveřejnění souhlasí. Zaslání Smlouvy do registru smluv provede Příjemce neprodleně po uzavření této Smlouvy. Tato Smlouva nabývá platnosti dnem podpisu poslední Smluvní stranou a účinnosti dnem uveřejnění prostřednictvím registru smluv.</p>
                </con-option>
            </con-options>
        </con-section>

Příklad předání volby v JSON

...
{
"id": "221", 
"value": "V.2  Tato Smlouva nabývá účinnosti okamžikem jejího podpisu oběma Smluvními stranami."
},
...

<con-part hideable=true con-id=“5”>
.... text, který  někdy je a není zobrazen
</con-part>

...
{"id": "5","value": "hide"},
...

"contract_id": "83166",
"signer_data": {
    "firstname": "Roman",
    "surname": "Řípa",
    "address": "Praha",
    "birthdate": "06-08-1970"
},
"state": "completed",
"modified": "23-06-2021",
"file": " <style>\n 
...

[
    {
        "docs_person": {
            "email": "demo@signi.com",
            "firstname": "Kapitán",
            "lastname": "Demo",
            "docs_role": "proposer",
            "mobile": ""
        },
        "contract_role": "sign",
        "state": "signed",
        "contract_first_shown_date": "2021-06-22T15:21:18+02:00",
        "signature_field_show_date": "2021-06-22T15:21:18+02:00"
    },
    {
        "docs_person": {
            "email": "roman.ripa@signi.com",
            "firstname": "Roman",
            "lastname": "Řípa",
            "docs_role": "counterparty",
            "mobile": "+420605202397"
        },
        "contract_role": "sign",
        "state": "signed",
        "contract_first_shown_date": "2021-06-22T15:22:06+02:00",
        "signature_field_show_date": "2021-06-23T09:52:46+02:00"
    }
]

{
   "settings":{
      "signing_order": "one_at_a_time",
      "one_device":true
   },
   "people":[
      {
         "is_proposer":true,
         "email":"test@signi.com",
         "contract_role":"sign",
         "positions":[
            {
               "x":15,
               "y":50,
               "page":0
            }
         ]
      },
      {
         "is_proposer":false,
         "party_order":1,
         "email":"unregistered+1@example.com",
         "contract_role":"sign",
         "positions":[
            {
               "x":15,
               "y":80,
               "page":0
            }
         ],
         "first_name":"John",
         "last_name":"Doe#1",
         "person_type":"legal"
      },
      {
         "is_proposer":false,
         "email":"unregistered+2@example.comm",
         "contract_role":"sign",
         "positions":[
            {
               "x":50,
               "y":80,
               "page":0
            }
         ],
         "first_name":"John",
         "last_name":"Doe#2",
         "person_type":"legal"
      }
   ],
   "file":"uploaded_file_key"
}

{
  "contract_id": "1234",
  "attachments": [],
  "state": "pending",
  "notifications": [
    {
      "email": "unregistered+1@example.com",
      "links": {
        "contract": "https://app.signi.com/contract/received/67ecf33b..."
      }
    },
    {
      "email": "unregistered+2@example.com",
      "links": {
        "contract": "https://app.signi.com/contract/received/b4fe4d95..."
      }
    }
  ]
}

{
"number": "RU21001",  
"contract_name": "Dokument ve stavu draft",
"state": "draft",
"locale": "cs",
....

Pozor""" - Smysl má volat požadavek na identifikaci pouze u protistran tj. “doc_role”:”counterparty”, nikoliv u navrhovatelů tj. “doc_role”:”proposer“. Pokud je požadována identifikace navrhovatelů, vrátí API chybu.

[
  {
    "signIdentityId": 116,
    "enabledAuths": [
      "aml", "bankId"
    ]
  }
]

{
  "links": [
    {
      "full_name": "Tomáš Johanovský",
      "link": "https:\/\/app.test.signi.tech\/dashboard\/workspace\/597\/documents\/12291"
    },
    {
      "full_name": "John Doe#1",
      "link": "https:\/\/app.test.signi.tech\/auth\/FGDYDLF7jp6xqcf4ID6xHg6Hi4fjMNGUrtf42PL8dPbVjJRZn8IfFtE3pR6fpVJBEjVWB5FyVl2j6qFv11E0Jb7qpjM1HMdyeFXxZHMMHllXx5YKrl4NeKcC"
    }
  ]
}