Anropas om documentType är "html", se /settings. När användaren öppnar e-signen i Upsales visas din sida i ett helskärmsfönster, där användaren gör klart e-signen i ditt system och skickar den till mottagaren.
Endpoint POST https://yourapp.com/iframe
Anropet är ett POST-anrop med en JSON-body, och appens endpoint måste använda HTTPS.
Body
Body:n har samma fält som alla anrop till appar, se Anropets body. body.data innehåller:
-
name:esignDocumentför e-sign. Upsales anropar /iframe för varje iframe som din app visar, så användnameför att skilja ut det här anropet. -
typeId:editEsign. -
objectId: e-signens ID i Upsales (se nedan). -
userId: ID för användaren som öppnade e-signen.
body.data.objectId
Dokument-ID som motsvarar e-signen i Upsales. Med det kan integrationen göra ett anrop till Upsales och hämta hela e-signen. På e-sign-objektet finns dokument-ID:t, som du kan använda för att öppna rätt e-sign i iFramen.
Svar
Svara inom 30 sekunder med status 200 eller 201 och en JSON-body med fältet runConfigs. runConfigs är en sträng med den HTML som Upsales visar för användaren, till exempel en iframe med sidan där användaren kan redigera och skicka sin e-sign. Om din app svarar med någon annan status, utan runConfigs, eller inte svarar i tid, får användaren ett felmeddelande i stället för din sida.
Exempelsvar
{
"runConfigs": "<iframe style=\"width: 100%; height: 100%; border: none;\" src=\"URL_TO_ESIGN\"></iframe>"
}