Chyby a jejich řešení

Když se volání nepovede, API vrátí číselný kód a hlášku. Hláška zpravidla říká, co přesně opravit — vždy si přečtěte celé tělo odpovědi.

Přehled návratových kódů

Jak vypadá chybová odpověď

Jednoduché chyby vrací jen hlášku, např. špatný klíč (401):

{ "message": "No valid token found" }

Strukturované chyby nesou i kód a překladový klíč:

{
    "code": 400,
    "errorCode": "Signi.Exceptions.PublicApi.ContractBadRequestException",
    "translationKey": "public_api.bad_request…",
    "message": "…co je špatně…"
}

Typické hlášky u chyby 400

„Invalid JSON" / „Invalid or missing json request provided"

• V JSON pokynech je překlep — pomůže JSON validátor.
• Nebo soubor není v kódování UTF-8, případně v požadavku úplně chybí.

„Contract must have at least one proposer."

• V people musí být nejméně jeden člověk s "is_proposer": true — autor dokumentu (navrhovatelů může být i více).

„Contract role [role] is not enabled for this workspace"

• Použitá role podepisujícího (např. podpis certifikátem) není ve vašem workspace povolená. Ověřte nastavení workspace, případně kontaktujte podporu.

„Function [funkce] cannot be used for contract role [role]"

• Kombinace role a funkce nedává smysl — zkontrolujte contract_role u lidí v JSON.

„Webhook is invalid" / „Webhook state [state] is not allowed"

• Adresa webhooku není platná, nebo hlásíte stav, který webhook neumí. Podporované stavy: pending, completed, rejected, expired.

Podepisující není ve workspace

• E-mail podepisujícího s účtem v Signi musí být přiřazený do workspace, ke kterému patří API klíč — viz poznámka v Quickstartu.

Kam dál

• Quickstart — první dokument k podpisu přes API
• Úplný přehled volání a odpovědí