Dit artikel begeleidt u door het proces van het versturen van een document ter ondertekening met behulp van een sjabloon via de Sign.Plus eSignature API.
Door deze stappen te volgen, maakt u een envelop aan op basis van een sjabloon, stelt u de gegevens van de ontvangers in en verstuurt u de envelop ter ondertekening.
Vereisten
- Een Sign.Plus-account met een API-abonnement
- Uw
Personal Access Token - Een bestaand sjabloon in uw Sign.Plus-account
Stap 1: Maak een envelop aan op basis van een sjabloon
- Gebruik het POST /v2/envelope/from_template/{template_id}-endpoint om een nieuwe envelop aan te maken op basis van een sjabloon.
- Vervang
{template_id}door de ID van uw bestaande sjabloon.
Waar vindt u uw sjabloon-ID?- Ga naar https://app.sign.plus/templates .
- Klik op de naam van het gewenste sjabloon.
- Kopieer de ID uit de rechterzijbalk.
- Ga naar https://app.sign.plus/templates .
- Stuur een POST-verzoek naar
POST /v2/envelope/from_template/{template_id}met de volgende JSON-body:{"name": "My wonderful envelope from template"} - Neem uw API-sleutel op in de
Authorization-header. - Bij succes ontvangt u
een Envelope-object.{"id": "66eb7d0467d2d549b89fcb6d",// ..."signing_steps": [{"recipients": [{"id": "66eb7d0467d2d549b89fcb70","uid": null,"name": "","email": "","role": "SIGNER","verification": null}]},{"recipients": [{"id": "66eb7d0467d2d549b89fcb71","uid": null,"name": "","email": "","role": "RECEIVES_COPY","verification": null},{"id": "66eb7d0467d2d549b89fcb72","uid": null,"name": "","email": "","role": "SIGNER","verification": null}]}],"documents": [// ...],"notification": {// ...}} - Sla de geretourneerde
idop alsenvelope_idvoor toekomstige API-aanroepen. - Noteer de
idvan elke ontvanger voor later gebruik in het ondertekeningsproces.
Voorbeelden:-
66eb7d0467d2d549b89fcb71: EersteSIGNER(stap 1) -
66eb7d0467d2d549b89fcb71:RECEIVES_A_COPY(stap 1) -
66eb7d0467d2d549b89fcb72: TweedeSIGNER(stap 2)
-
Stap 2: Gegevens van ontvangers instellen
Als uw sjabloon geen vaste ontvangers heeft en u de gegevens van ontvangers moet instellen of bijwerken:
- Gebruik het endpoint POST /v2/envelope/{envelope_id}/signing_steps om de gegevens van ontvangers bij te werken.
- Vervang
{envelope_id}door de ID die u in stap 1 hebt ontvangen. - Verstuur een
POST-verzoek met de volgende JSON-body:{
"signing_steps": [
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb70",
"name": "John Doe",
"email": "john.doe@example.com",
"role": "SIGNER"
}
]
},
{
"recipients": [
{
"id": "66eb7d0467d2d549b89fcb71",
"name": "Mark Twain",
"email": "m.twain@example.com",
"role": "RECEIVES_COPY"
},
{
"id": "66eb7d0467d2d549b89fcb72",
"name": "Jane Smith",
"email": "j.smith@example.com",
"role": "SIGNER"
}
]
}
]
} - Bij succes ontvangt u een array van
SigningStep-objecten.
Stap 3: Verstuur uw envelop ter ondertekening
- Gebruik het endpoint POST /v2/envelope/{envelope_id}/send om de envelop te versturen.
- Vervang
{envelope_id}door uw envelop-ID uit stap 1. - Verstuur een
POST-verzoek naar dit endpoint. - Bij succes wordt de envelop ter ondertekening naar de ontvanger(s) verzonden.
Conclusie
U hebt nu met succes een document ter ondertekening verzonden met behulp van een sjabloon via de Sign.Plus eSignature API. De ontvanger(s) ontvangen een e-mailmelding met een link om het document te ondertekenen.
Het gebruik van sjablonen kan uw ondertekeningsworkflow aanzienlijk stroomlijnen, vooral voor veelgebruikte documenten met een consistente opmaak en vaste ondertekeningsvereisten.