Dokument ze vzoru

Místo hotového souboru můžete dokument vytvořit ze vzoru — šablony uložené v Signi s vyplňovanými poli. Přes API pak posíláte jen hodnoty polí, žádný soubor.

Vzory jsou placené rozšíření služby Signi.

Tvorba vzorů

Vzory si můžete vytvořit v aplikaci v Editoru vzorů. Vzor obsahuje text dokumentu s vyplňovanými poli — přes API pak do polí jen dosazujete hodnoty.

Jak to funguje

V JSON pokynech místo pole file použijete template — ID vzoru a hodnoty jeho parametrů:

{
    "people": [
        {
            "is_proposer": true,
            "email": "vas@email.cz",
            "contract_role": "sign"
        },
        {
            "is_proposer": false,
            "party_order": 2,
            "email": "protistrana@email.cz",
            "contract_role": "sign",
            "first_name": "Jan",
            "last_name": "Novák",
            "person_type": "legal"
        }
    ],
    "template": {
        "id": 8,
        "parameters": [
            { "id": "11", "value": "Praha" }
        ]
    }
}

Volání je pak jednodušší — posílá se jen JSON, bez souboru:

curl -X POST "https://api.signi.com/api/v1/contract/" \
  -H "x-api-key: VAS_API_KLIC" \
  -F "data=@dokument.json;type=application/json"

K čemu je party_order

Vzor má předem definované smluvní strany (např. objednatel a zhotovitel). party_order říká, ke které straně vzoru člověk patří — číslo strany. V příkladu výše je protistrana stranou č. 2.

Pozice podpisů řešit nemusíte — jsou dané vzorem.

Konkrétní příklad

Vyzkoušejte si vyplnění Souhlasu s elektronickou komunikací — stáhněte si ukázkový JSON (e-maily a telefon nahraďte svými):

{
    "contract_name": "Souhlas s elektronickou komunikací - Test Tester",
    "locale": "cs",
    "state": "pending",
    "settings": {
        "signing_order": "all_at_once",
        "autosign_proposers": "V Praze"
    },
    "people": [
        {
            "is_proposer": true,
            "email": "test@signi.com",
            "contract_role": "sign"
        },
        {
            "is_proposer": false,
            "email": "test+1@signi.com",
            "contract_role": "sign",
            "phone": "603123456",
            "first_name": "Test",
            "last_name": "Tester",
            "person_type": "nature"
        }
    ],
    "template": {
        "id": "2105",
        "parameters": [
            { "id": "101", "name": "Jméno / Název společnosti", "value": "Test Tester" },
            { "id": "102", "name": "Adresa / Místo podnikání", "value": "Testovací 123, 110 00 Praha" },
            { "id": "103", "name": "Datum narození / IČO", "value": "8.8.2006" },
            { "id": "131", "name": "Název", "value": "Ukázková firma s.r.o." },
            { "id": "132", "name": "IČO", "value": "12345678" },
            { "id": "121", "name": "např", "value": "pracovní smlouvy, dohody, mzdové výměry" },
            { "id": "141", "name": "Pro společnost", "value": "Ukázková firma s.r.o." },
            { "id": "142", "name": "IČ", "value": "12345678" },
            { "id": "143", "name": "Sídlo", "value": "Firemní 1, 110 00 Praha" },
            { "id": "151", "name": "Email", "value": "test+1@signi.com" },
            { "id": "152", "name": "Telefon", "value": "603123456" }
        ]
    }
}

Všimněte si polí contract_name (název dokumentu), locale (jazyk komunikace) a settings.autosign_proposers — navrhovatel podepíše automaticky, jen se doplní místo podpisu.

Odeslání:

curl -X POST "https://api.signi.com/api/v1/contract/" \
  -H "x-api-key: VAS_API_KLIC" \
  -F "data=@vzor-souhlas-el-komunikace.json;type=application/json"

Co se vrátí:

{
    "contract_id": 1234567,
    "state": "pending",
    "notifications": [
        { "email": "vas@email.cz",
          "links": { "contract": "https://app.signi.com/dashboard/workspace/…/documents/1234567" } },
        { "email": "protistrana@email.cz",
          "links": { "contract": "https://app.signi.com/signing/…/received" } }
    ]
}

• contract_id — ID dokumentu pro další volání (stav, stažení).
• notifications — odkazy pro jednotlivé lidi: navrhovatel do workspace, protistrana přímo na podpisovou stránku. Odkaz můžete protistraně zobrazit rovnou ve své aplikaci, nemusí čekat na e-mail.

Kde zjistím ID vzoru a parametrů

Seznam vzorů workspace vrátí:

curl -H "x-api-key: VAS_API_KLIC" https://api.signi.com/api/v1/contract/templates

{
    "templates": [
        {
            "id": 123,
            "name": "Souhlas s elektronickou komunikací",
            "parameters": [
                { "id": "101", "type": "con-textarea", "name": "Jméno / Název společnosti", "values": null },
                { "id": "131", "type": "con-options", "name": "Předmět smlouvy", "values": ["první", "druhá"] }
            ]
        }
    ]
}

U každého vzoru vidíte ID a seznam parametrů — typ con-options znamená výběr z hodnot ve values.

Kam dál

• Více podepisujících
• Automatický podpis navrhovatele — hodí se u dokumentů generovaných ze vzorů
• Quickstart — první dokument k podpisu přes API