Utvecklardokumentation för elektronisk signering av dokument.

Endpointen send används när en användare skickar en ny e-sign. Om documentType är 'html' ska endpointen skapa ett utkast i tredjepartssystemet och svara med dokument-ID:t. documentType är värdet som din app returnerar från /settings ('pdf' eller 'html', standardvärdet är 'pdf').

Endpoint
POST https://yourapp.com/send

Endpointen måste använda HTTPS.

Body
Request body.data innehåller information om filen och mottagarna.

body.data.file
Filen som ska skickas. Använd body.data.file.id för att ladda ned filen från Upsales via endpointen GET https://integration.upsales.com/api/v2/resources/download/internal/<id>?token=<body.apiKey>. Svarets body är den råa filen.

body.data.involved
En array med e-signens mottagare.

Svar
Svara med status 200 eller 201. Som standard väntar Upsales 30 sekunder på svaret. Med någon annan status, eller om inget svar kommer i tid, misslyckas utskicket. Om du vill visa användaren varför tar du med egenskapen message i felsvarets JSON-body.

Vid ett lyckat anrop måste svaret vara ett JSON-objekt med egenskapen documentId, och den får inte vara tom. documentId sparas på e-sign-objektet i Upsales.

Exempelsvar

{
  "documentId": "myEsignId123"
}

Tips vid utskick
Använd avsändarens designprofil för att formge webbsidorna och e-postmeddelandena som hör till e-signen. Du hämtar profilen med det här anropet: GET https://power.upsales.com/api/v2/accountProfile?token=<body.apiKey>