Štítky

Štítky pomáhají dokumenty ve workspace třídit. Přes API je vypíšete, založíte a přiřadíte dokumentu při vytvoření.

Štítky a složky jsou jeden systém — složka je štítek s "is_folder": true. Zařazení dokumentu do složky popisuje článek Složky a zařazení dokumentu.

Výpis štítků

curl -H "x-api-key: VAS_API_KLIC" https://api.signi.com/api/v1/tags/list

[
    { "id": 123, "name": "Smlouvy", "workspace": { "id": 12345, "name": "Demo" }, "is_folder": false }
]

Vytvoření štítku

curl -X POST -H "x-api-key: VAS_API_KLIC" -H "Content-Type: application/json" \
  https://api.signi.com/api/v1/tags/create \
  -d '{ "name": "Smlouvy", "is_folder": false }'

Vrátí se ID nového štítku (číslo). Stejné jméno nejde použít dvakrát.

Pozor: pole is_folder je povinné — bez něj volání selže. false = štítek, true = složka. Smazat štítek přes API zatím nejde.

Dokument se štítkem

Štítky se dokumentu přiřazují při zakládání — polem tags se seznamem ID:

{
    "people": [ … kdo podepisuje … ],
    "file": "uploaded_file_key",
    "tags": [123]
}

Že se štítek přiřadil, uvidíte v detailu dokumentu:

{ "contract_id": "1234567", "state": "pending", "tags": [ { "id": 123, "name": "Smlouvy" } ] }

Kam dál

• Složky a zařazení dokumentu
• Kontakty
• Quickstart — první dokument k podpisu přes API