Vlastní data u dokumentu (metadata)

Do dokumentu si můžete uložit vlastní data — třeba ID objednávky, poznámku nebo cokoli z vašeho systému. Signi je nijak nezpracovává, jen je uchová a vrátí vám je zpět. Ideální pro spárování dokumentu v Signi se záznamem u vás.

Jak na to

Při zakládání dokumentu přidejte pole metadata. Hodnota musí být JSON (zapsaný jako text s odescapovanými uvozovkami) — jednotlivé položky se pak zobrazí v aplikaci Signi na přehledu dokumentů i v detailu dokumentu, každá zvlášť:

{
    "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": "nature",
          "positions": [ { "x": 50, "y": 80, "page": 0 } ] }
    ],
    "metadata": "{\"poznámka\": \"nějaká dlouhá poznámka s hodně slovy.\",\"barva\": \"modrá\",\"velikost bot\": \"34\"}",
    "file": "uploaded_file_key"
}

Kde je dostanete zpět

V detailu dokumentu přes API:

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

{
    "contract_id": "1234567",
    "contract_name": "Smlouva o dílo",
    "state": "pending",
    "metadata": "{\"poznámka\": \"nějaká dlouhá poznámka s hodně slovy.\",\"barva\": \"modrá\",\"velikost bot\": \"34\"}"
}

A v aplikaci Signi — na přehledu dokumentů a v detailu dokumentu, rozepsané po jednotlivých položkách.

Kam dál

• JSON pro vytvoření dokumentu — přehled všech položek
• Životní cyklus dokumentu