Nejsložitější částí Signi API je JSON s pokyny při vytváření dokumentu. Tento článek popisuje všechny položky, které do něj můžete zapsat — s odkazy na články s příklady.
Základní položky
| Položka | Význam |
|---|---|
file |
Název pole, ve kterém posíláte soubor dokumentu (typicky uploaded_file_key) — viz Quickstart. Nepoužívá se u dokumentu ze vzoru. |
people |
Seznam lidí na dokumentu — viz níže a Více podepisujících. |
state |
pending (výchozí — rovnou rozeslat k podpisu) nebo draft (rozpracovaný, nikomu neodejde) — viz Životní cyklus dokumentu. |
contract_name |
Název dokumentu. Bez něj se použije název souboru či vzoru. |
number |
Vaše interní číslo dokumentu (např. číslo objednávky). |
locale |
Jazyk dokumentu a e-mailů pro neregistrované protistrany: cs, sk, en, de, pl, hu, nl, bg, ru, ua, vi. |
url_redirect |
Adresa, kam bude podepisující přesměrován po podpisu — hodí se pro podpis v integrované aplikaci. |
waiting_limit |
Počet dní, po kterých nepodepsaný dokument expiruje. |
metadata |
Vlastní data k dokumentu ve formátu JSON (zobrazí se v aplikaci po položkách) — viz Vlastní data u dokumentu. |
view_order |
Pořadí zobrazení dokumentů obálky v aplikaci Signi — viz Pořadí zobrazení dokumentů. |
folder_id |
ID složky, kam se dokument zařadí (složka = štítek s is_folder) — viz Složky a zařazení dokumentu. |
Lidé (people)
Každý člověk v seznamu může mít:
| Položka | Význam |
|---|---|
email |
E-mail podepisujícího (povinné). |
is_proposer |
true = navrhovatel (vaše strana), false = protistrana. |
contract_role |
Podpisová role na dokumentu: sign, approve, stamp, sign_certificate, sign_bank_id_sign, sign_remote_sign, notice — viz Podpisové role. |
positions |
Kam umístit podpis — viz níže a Kam umístit podpisy. |
first_name, last_name |
Jméno — povinné pro neregistrované protistrany. |
person_type |
nature (fyzická osoba), legal (právnická), citizen (občan). Využívá se u vzorů. |
phone |
Telefon — používá se pro zasílání PIN kódů a SMS zpráv s výzvou k podpisu dokumentu. |
company_name, ic, dic |
Firma, IČO a DIČ (u právnických osob). U vzorů se propisují do hlavičky vzoru. |
street, city, zip_code |
Adresa. U vzorů se propisuje do hlavičky vzoru. |
organization_position |
Pozice ve firmě (např. „jednatel"). U vzorů se propisuje do hlavičky vzoru. |
date_of_birth |
Datum narození. U vzorů se propisuje do hlavičky vzoru. |
party_order |
Číslo smluvní strany — páruje lidi na strany u dokumentu ze vzoru. |
locale |
Jazyk e-mailů pro tohoto člověka (přebije locale dokumentu). |
personal_new_notification |
Osobní text, který dostane jen tento člověk v e-mailu s výzvou — viz Osobní zpráva pro podepisujícího. |
signature_footer |
Vlastní text v patičce podpisu — patička musí být zapnutá (showFooter), viz Hlavička a patička podpisu. |
workspace_id |
Cílový workspace člověka — jen pro registrované ze stejného účtu. |
is_visible |
Jen u příloh: false skryje přílohu tomuto člověku — viz Skrytí přílohy podepisujícímu. |
autosign_place |
Místo podpisu pro automatický podpis tohoto navrhovatele (alternativa k settings.autosign_proposers) — viz Automatický podpis navrhovatele. |
one_device |
true = tento člověk podepisuje na sdíleném zařízení (nedostane vlastní odkaz) — viz Podpis na jednom zařízení. |
Pozice podpisu (positions)
| Položka | Význam |
|---|---|
x, y |
Procenta velikosti stránky (0, 0 = levý horní roh, 100, 100 = pravý dolní); určuje levý horní roh obdélníku s podpisem. |
page |
Číslo stránky, od 0. Záporná čísla počítají od konce — -1 = poslední strana. |
relativeWidth |
Šířka podpisu v procentech šířky stránky (výchozí 30). |
anchor |
Místo zástupného pole v dokumentu — nahrazuje x/y/page, viz Kam umístit podpisy. |
showHeader, showFooter |
Zapnutí hlavičky/patičky podpisu — viz Hlavička a patička podpisu. |
Nastavení (settings)
| Položka | Význam |
|---|---|
signing_order |
Pořadí podepisování: all_at_once, proposers_before_counterparties, one_at_a_time — viz Pořadí podepisujících. |
autosign_proposers |
Automatický podpis navrhovatele — viz Automatický podpis navrhovatele. |
one_device |
Podpis protistran na zařízení navrhovatele — viz Podpis na jednom zařízení. |
missing_positions |
Co s podpisy bez pozic: error (výchozí) nebo append_to_the_end — nedoporučujeme, viz Kam umístit podpisy. |
lock_after_seal |
Zamknout dokument po dokončení — viz Zabezpečení dokumentu. |
presume_delivery |
Doručení fikcí — viz Doručení fikcí. |
presumed_delivery_days |
Vlastní délka lhůty doručení fikcí (místo výchozích 15 dní) — viz Doručení fikcí. |
sms_auth_before_download |
Vyžadovat ověření SMS kódem před stažením dokumentu (workspace musí mít funkci povolenou). |
convert_to_pdfa |
Převést dokument do formátu PDF/A. |
archive_expire_years |
Počet let archivace dokumentu (jen s aktivní archivací ve workspace, jinak se ignoruje) — viz Archivace dokumentu. |
Další celky
| Položka | Význam |
|---|---|
webhooks |
Automatická hlášení změn stavu: [{ "state": "completed", "url": "…" }] — viz Webhooky. |
email_notifications |
E-mailová upozornění podepisujícím — viz E-mailové notifikace. |
template |
Dokument ze vzoru: { "id": …, "parameters": [...] } — viz Dokument ze vzoru. |
tags |
Seznam ID štítků — viz Štítky. |
attachments |
Přílohy — každá má vlastní people, file, případně number, view_order, template a webhooks — viz Dokument s přílohami. |
Ukázka s většinou položek
Ověřený příklad kombinující základní položky, údaje o firmě, nastavení, webhook i notifikaci:
{
"contract_name": "Smlouva o dílo",
"number": "OBJ-2026-001",
"locale": "cs",
"state": "pending",
"url_redirect": "https://vase-aplikace.cz/podepsano",
"waiting_limit": 30,
"metadata": "vase-interni-id-123",
"settings": { "signing_order": "all_at_once" },
"people": [
{ "is_proposer": true, "email": "vas@email.cz", "contract_role": "approve" },
{ "is_proposer": false, "email": "protistrana@email.cz", "contract_role": "sign",
"first_name": "Jan", "last_name": "Novák", "person_type": "legal",
"company_name": "Firma s.r.o.", "ic": "12345678", "dic": "CZ12345678",
"street": "Dlouhá 1", "city": "Praha", "zip_code": "11000",
"organization_position": "jednatel", "phone": "+420603123456",
"positions": [ { "x": 50, "y": 80, "page": 0, "relativeWidth": 25 } ] }
],
"webhooks": [ { "state": "completed", "url": "https://vase-aplikace.cz/signi-hotovo" } ],
"email_notifications": [
{ "type": "before_sign_expiration", "recipients": ["vas@email.cz"], "days": 1 }
],
"file": "uploaded_file_key"
}
Kam dál
Byl tento článek užitečný?
To je skvělé!
Děkujeme Vám za zpětnou vazbu
Je nám líto, že jsme vám nepomohli
Děkujeme Vám za zpětnou vazbu
Zpětná vazba odeslána
Oceňujeme vaši snahu a pokusíme se článek opravit