Formulářový dokument z PDF se značkami (API)

ℹ️ Novinka — dostupné na produkci koncem října 2026.

Formulářový dokument — PDF, ve kterém protistrana před podpisem vyplní pole — jde založit i přes API. Nahrajete PDF se značkami v textu a Signi z nich udělá vyplňovací pole; totéž ve webové aplikaci popisuje Doplňování údajů do vzoru protistranou.

Značky v PDF

Do textu PDF vložte značky {XYZ:nazev_pole}, kde první písmeno určuje, kdo pole vyplní (c = protistrana, p = navrhovatel), druhé povinnost (r = povinné, o = nepovinné) a třetí typ (t = text, c = zaškrtávátko):

Jak na to

V settings pošlete "find_placeholders": true:

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

data.json:

{
    "contract_name": "Dotazník klienta",
    "state": "pending",
    "file": "document",
    "settings": { "find_placeholders": true, "signing_order": "all_at_once" },
    "people": [
        { "is_proposer": true, "email": "vas@email.cz", "contract_role": "sign" },
        { "email": "protistrana@email.cz", "first_name": "Jan", "last_name": "Novák",
          "person_type": "nature", "contract_role": "sign" }
    ]
}

Odpověď (zkráceno):

{
    "contract_id": 1234567,
    "state": "waiting_for_answers",
    "placeholder_detection": "done",
    "document_form_fields": [
        { "id": "jmeno", "name": "jmeno", "value": null, "filled_by": null,
          "assigned_to": { "role": "counterparty", "party_order": 1 } },
        { "id": "cislo_smlouvy", "name": "cislo_smlouvy", "value": null, "filled_by": null,
          "assigned_to": { "role": "proposer", "party_order": null } }
    ]
}

Dokument přejde do stavu waiting_for_answers — protistrana nejdřív vyplní pole a teprve pak podepisuje (viz Životní cyklus dokumentu).

Když hledání značek trvá déle

Když hledání nedoběhne do 30 sekund, odpověď vrátí "state": "draft" a "placeholder_detection": "processing". Pak:

1. čtěte GET /api/v1/contract/ID_DOKUMENTU, dokud placeholder_detection není done,
2. obálku odešlete přes POST /api/v2/docs/UUID_DOKUMENTU/send.

Vyplněné hodnoty po podpisu vrací GET /api/v1/contract/ID_DOKUMENTU/fields.

Omezení

• Workspace musí mít formulářový dokument zapnutý.
• find_placeholders nejde kombinovat se šablonou ani s přílohami.
• Max. 50 stran PDF, max. 20 různých značek, alespoň jedna značka v PDF.

Kam dál

• Doplňování údajů do vzoru protistranou — totéž ve webové aplikaci
• JSON pro vytvoření dokumentu — přehled všech položek