Pro práci s podpisovým scénářem je nejprve třeba znát ID scénáře, který si přeji použít.
V selfcare ID najdeme dole v detailu scénáře (Nastavení>Podpisové scénáře):
Přes API ID dohledáme přes endpoint pro výpis scénářů (List Signature scenarios): /api/account/signature-scenarios
Při vytváření příjemce poté v těle requestu pošleme navíc IRI scénáře.
IRI se sestaví ve tvaru /api/account/signature-scenarios/{id_scénáře}
POST /api/envelopes/3974d252-b027-46df-9fd8-ddae54bc9ab9/recipients
{
"role": "signer",
"name": "John Doe",
"email": "john.doe@example.com",
"mobile": "+420111222333",
"scenario": "/api/account/signature-scenarios/0187...db06"
// ...
}
V odpovědi se pak vrátí i informace o vybraném scénáři a konkrétní použité verzi.
{
// ...
"scenario": "/api/account/signature-scenarios/0187...db06",
"scenarioVersionInfo": {
"id": "13a7532d-93bd-461a-ac9e-dc7019fbd3e2",
"name": "Název scénáře",
"version": 1
}
}