Key aspects of an API integration

In this article we will explain the 5 key aspects of an API integration that we recommend that you take into account in your development.

If you haven't yet followed the steps to get started with the API integration, you can do it here.

We recommend that you check the API integration section in our Help Center to find more information.

1. API Integration: Create Signature

The most important parameters to use to make a signature request would be:

recipients: list of recipients (signer, validator, cc)
delivery_type: if not indicated, it will be by default by email
files: (PDF documents in binary format) or templates (Signaturit templates)
widgets: widgets parameters
type: simple or advanced signature

Other parameters that are often used in this call:

Word Anchor: allows you to place a widget in relation to a word in the document. For example, it is used to place the signature widget when the word “Sign” appears in the document. This parameter is the one we recommend to use when sending dynamic documents to sign.

If the word in question is used multiple times in the document, a signature field will appear for each word.

Data parameter: is used to enter values ​​in a form field. These fields can be created from the Templates section of the Signaturit dashboard, or they can be entered in the PDF with an editing program.

In this way, as soon as the field ID corresponds to a field in the PDF, this value will be stamped directly on the document.

We recommend this article from our help center to better understand how it works.

Reminders: these are reminders that are sent to the signers. You must indicate how often you want to send an automatic reminder to the signer in case they have not signed the document.

If it is a document with multiple signers, the reminder will always be sent to whoever has not signed yet.

A reminder will always be sent by the same delivery_type of the request, as long as it is by email or SMS.

2. API Integration: Branding

With the banding you can customise certain aspects of the communication, such as the templates of the emails sent to the signers or the colours.

You can create as many brandings as you wish, each with its own characteristics (eg. you can create a branding per language). Every time you create a branding, you will get a branding ID that will have to be indicated in the Create Signature calls. The branding that will appear by default if branding_id is not indicated is the last one created.

The main email templates sent to signers that can be fully customised using HTML are:

'signatures_request' → signature request
'signatures_receipt' → signature completed, copy of signed document
'pending_sign' → signature reminder
'document_canceled' → signature cancellation

You can read more about branding here.

3. API Integration: Subscriptions

Subscriptions allows you to subscribe to specific events and thus receive alerts in real time about the signing processes. This is a call in which you indicate the URL where you want to receive events and the events you want to subscribe to.

The events we recommend subscribing to are the following:

'email_bounced'
'email_deferred'
'document_completed'
'document_declined'
'document_canceled'
'audit_trail_completed'

4. API Integration: Downloading the signed document

The signed document can be downloaded from the Signaturit system and uploaded to your CRM, ERP or system. This document will be available as soon as the “document_completed” event is received.

You can also download the audit trail with this call.

5. API Integration: Moving to production

Finally, once the integration is complete, you will go to production following these instructions.

To do this, you only have to change the Sandbox token for the production one and the endpoint URL.

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk