V jakých formátech se předávají soubory k podpisu?
V aktuální verzi lze přes API posílat v PDF, DOC, DOCX, XLS, XLSX, JPG, HTML .
V HTTP requestu se soubory k podpisu s předávají ve formátu - multipart/form-data.
PŘIPRAVUJEME:
Ve variantě End Pointů Full RestAPI budou binární soubory překódovány do textu.
Jak předávat informaci o umístění podpisů při předávání souborů?
Umísťování podpisů se řeší v případě, že posíláte k podpisu své dokumenty. V případě využití vzorů Signi jsou pozice podpisů dány vzorem.
Jaké jsou možnosti:
Umístění podpisů na závěr dokumentu
Umístění podpisu na zadanou stránku a souřadnice
Umístění podpisů dle Pole pro umístění podpisů - Placehoder
1. Umístění podpisů na závěr dokumentu
Nejjednodušším způsobem, jak umístit podpisy do dokumentů, je, že Sifni přidá k výslednému PDF dokumentu samostatný list na závěr dokumentu a umístí tam všechny podpisy. Při volání endpointu Vytvoření smlouvy 2.0 > Z dokumentu se jako jeden z parametrů v sekci settings uvede "missing_positions": "append_to_the_end" . Více také viz Příklad 2 - Umístění podpisů na závěr dokumentu.
Přiklad dynamického umístění podpisu
2. Umístění podpisu na zadanou stránku a souřadnice
Při volání endpointu Vytvoření smlouvy 2.0 > Z dokumentu lze i přesně určit, kde má být podpis umístěn v poli positions u každé osoby. Tím se pokryjí typicky formuláře, kde je místo k podpisu vždy stejné.
Určuje se parametry X, Y, sign_proposer[position][x] sign_proposer[position][y] sign_proposer[position][page] a sign_negotiator[position][x] sign_negotiator[position][y] sign_negotiator[position][page]
Jde o vzdálenost horního levého rohu podpisu od horního levého rohu dokumentu, bráno k rozměrům nahrávaného dokumentu v %, tj. hodnota je v rozmezí 0 - 100.
Doporučená velikost podpisů pro nahrání do profilu podepisujícího: od 2034 x 792 do 646 x 298.
Určuje se umístění každého podepisujícího a podpisu zvlášť, tj. na dokumentu může být libovolný počet podpisů, např. u vícestranných smluv či více podepisujících statutářů.
Pří více záznamech v poli positions je naopak podpis jednoho podepisujícího vyžadován na více místech jednoho dokumentu. To se hodí např. v případech, kdy je v jednom PDF sloučeno více dokumentů a podepisující se má podepsat na několik z nich.
3. Umístění podpisů dle Pole pro umístění podpisů - Placeholder
Další možností jak určit umístění podpisů přímo v dokumentu je vložením tzv. polí pro umístění podpisů, v angličtině nazývaných např. placehoders, na vhodná místa v dokumentu. Logika je podobná jako u polí v šablonách pro hromadnou korespondenci, pouze se nenahrazují hodnoty typu [příjmení] ,ale nahrazují se podpisy konkrétních lidí . Více také v Příklad 2 - Použití C - Využití polí pro podpis / placeholdery.
V dokumentu k popisu
V dokumentu určeném k podpisu je třeba nejprve umístit pole pro umístění podpisu dle následujících pravidel:
Pole pro umístění jednotlivých podpisů označují texty např. “signi-signature-0” , “signi-signature-1”, “signi-signature-2”, “signi-signature-3” atd. pro první, druhý a další podpis. Číslování podpisů by mělo odpovídat pořadí podepisování dokumentu. Pole pro toho, kdo má podepsat první je “signi-signature-0” .
Při volání přes API , na rozdíl pro umísťování podpisů v uživatelském rozhraní, není nutné tuto jmennnou konvenci dodržovat. Názvy polí libovolná, jen je třeba následně stejné názvy použít ve volání Signi API. Jediné doporučení od vývoje Signi - nepoužívejte v názvech polí mezery, diakritiku, speciání znaky a místo podtržítek použivejte pomlčky.
Text s názvem odpovídá levému hornímu rohu finálního vloženého podpisu. Text s názvem je vhodné uvádět v dokumentu bíle. Text ve výsledném PDF sice zůstane, ale bude překryt podpisem.
Při umisťování podpisů se počítá s tím, že podpis je široký cca na ⅓ stránky a vysoký je v poměru cca 16:9 . Pro umístění textů je tedy vhodné do dokumentu vložit tabulku s 2 či 3 sloupci. I tabulku je následně třeba obarvit na bílo.
Nezáleží na typu podpisu. - Do pole pro umístění v dokumentu lze vložit jakýkoliv typu podpisu - biometrický, BankIS SIGN či podpis s certifikátem například kvalifikovaný podpis.
V dokumentu může být pole pro podpis umístěno na více místech dokumentu. - JEden podepsiující pak budepodepsán v dokumentu vícekrát.
V dokumentu může být více polí pro umístění podpisů než je v podpisovém scénáři. - Dokument pak může počítat s tím, že za jednotlivé strany podepisuje více podepisujících.
Pokud je třeba podpis zmenšit, je to nyní možné nastavit jako vlastnost workspace v Signi, ne pro jednotlivá volání Signi API. Kontaktujte pro nastavení help@signi.com .
V JSON
Následně v podpisovém scénáři v JSON ve volání API se příslušná pole pro umístění podpisu uvedou u konkrétních osob v poli positions v proměnné anchor tj. např. signi-signature-00
a signi-signature-02
, příklad celého volání viz Příklad 2 - Použití C - Využití polí pro podpis / placeholdery.
{ "is_proposer": false, "email": "zakaznik@seznam.cz", "contract_role": "sign", "person_type": "nature", "first_name": "John", "last_name": "Doe#2", "positions": [ { "anchor": "signi-signature-0" } ] }
Pole pro umístění podpisu - placeholder přířazené ke konkrétní osobě v JSON požadavku na Signi API