Personalizar tus envíos y comunicaciones: Branding API

El Branding permite personalizar el proceso de firma y adecuarlo al look and feel de vuestra empresa. Se pueden customizar ciertos aspectos de la comunicación, como son los correos enviados a los firmantes, los colores y textos de la aplicación de firma.
 

¿Qué se puede personalizar?

Creando tu propio branding puedes modificar los siguientes aspectos: 

layout_color: Personaliza el color de los botones

Screenshot_2020-10-13_at_23.11.17.png

logo: La imagen del logo tiene que estar codificada en base64 y es la que aparece en las notificaciones de email y en la pantalla de instrucciones de firma.

Screenshot_2020-10-13_at_23.14.52.png

signature_color: Elige el color de la firma entre azul y negro. El color azul está mejor aceptado en instituciones tradicionales, aunque ambos colores son igualmente válidos legalmente. 

text_color: Pon el código del color en HTML con # para aplicar un color distintivo a los textos de la aplicación de firma.

Screenshot_2020-10-13_at_23.19.18.png

 

application_texts: modifica el texto de los diferentes botones existentes durante el proceso de firma.

application_texts[send_button]: Modifica el texto incluido dentro del botón que pulsará el firmante para finalizar la petición de firma:

Screenshot_2020-10-13_at_23.34.29.png

application_texts[open_sign_button]: botón para acceder a la petición incluido en el correo electrónico que recibe el firmante:

Screenshot_2020-10-13_at_23.38.19.png

application_texts[open_email_button] : botón para acceder al e-mail certificado incluido en el correo electrónico que recibe el destinatario. 

Templates[tipo_de_correo]: Modifica las plantillas de email que envía Signaturit. Hay 6 tipos de plantillas de correo que puedes modificar y asignar a tu branding. Abajo encontrarás las instrucciones detalladas para modificar las plantillas de correo electrónico. 

show_csv: Activa o desactiva el sello QTSP en el documento firmado.

 

Plantilla HTML de correo personalizadas 

Importante: No se debe confundir el parámetro "templates" del branding con el parámetro "templates" a la hora de hacer una petición de firma. El primero es para modificar las plantillas HTML de correo electrónico y el segundo es para enviar un documento plantilla a firmar. 

Las plantillas HTML de correo se tienen que subir en formato HTML. Para subirlas hay que utilizar el parámetro templates y luego especificar el tipo de email como en el siguiente ejemplo:

Templates[signatures_request]:<html>Email in HTML</html>

  • signatures_request: este es el primer email que recibe el firmante. Este email contiene el enlace al documento y es obligatorio el uso de la palabra mágica "sign_button" para que el firmante pueda abrir el documento y firmarlo.
  • signatures_receipt: cuando el proceso de firma finaliza, el firmante recibe este email con el documento firmado adjunto en PDF. IMPORTANTE: No afecta a la notificación que recibe el remitente con el audit trail y el documento firmado.
  • request_expired: el firmante recibe este email cuando el documento no se ha completado y expira. 
  • pending_sign: este email se envía en caso de tener los recordatorios activados o cuando se reenvía uno de nuevo. Como en "signatures_request", aquí también es obligatoria la palabra mágica "sign_button". 
  • document_canceled: aviso al firmante de que el documento ha sido cancelado. 
  • emails_request: en las comunicaciones certificadas (email certificado), este es el aviso de que ha llegado un email o un documento certificado. 

Sobre las magic words: Las magic words se usan a modo de etiqueta para recibir información variable de Signaturit.  No se pueden añadir magic words personalizadas, sino que se tiene que utilizar las disponibles.

Algunas son opcionales y otras son obligatorias (como el "sign_button" en los emails de peticiones de firma). Aquí tienes algunas de las magic words que puedes usar (todas se pueden encontrar aquí): 

  • {{sign_button}}: La etiqueta se remplaza por el botón de "Enviar documento".
  • {{signer_name}}: La etiqueta se remplaza por el nombre del firmante.
  • {{filename}}: La etiqueta se remplaza por el nombre del archivo (en caso que haya múltiples documentos en la misma petición, solamente se indicará uno de ellos).
  • {{logo}}: La etiqueta se remplaza por el logo.
  • {{email_body}}: La etiqueta se remplaza por el cuerpo del mensaje del email certificado.

En caso de querer añadir alguna imagen en el HTML, ésta tiene que ser en forma  URL.

 

Crear plantilla de SMS: 

  • sms-templates[sms_verify] -> Plantilla con el código OTP para entrar en el documento
  • sms-templates[sms_validate] -> Plantilla con el código OTP al final del proceso.

Branding ID

Cada vez que se cree un branding, se obtendrá un branding ID que podrás indicar en las llamadas de Create Signature con el parámetro “branding_id”. De esta forma, podéis crear tantos brandings como deseéis, cada uno con sus características.

curl -X POST \
https://api.signaturit.com/v3/signatures.json \
-H 'Authorization: Bearer TOKEN' \
-F 'recipients[0][name]=XXX' \
-F 'recipients[0][email]=XXX' \
-F 'templates[0]=#TEST' \
-F 'branding_id=#IDBRANDING'

Signaturit coge por defecto el último branding creado. Eso significa que si en una llamada a la API no se especifica ningún branding_id o se realiza un envío desde el dashboard, Signaturit utilizará el último branding que habéis creado.

Si queréis que se utilice el branding por defecto de Signaturit en estos casos (para evitar errores entre varias cuentas), una vez hayáis creado todos los brandings necesarios, podéis realizar una última llamada de branding vacía (sin parámetros). Esto reiniciará el branding por defecto.

 

Ejemplos:

En esta colección de Postman que puedes importar encontrarás una petición de branding completa que puedes usar para guiarte: enlace a la colección.

curl --location --request POST 'https://api.signaturit.com/v3/brandings.json' \ 
--header 'Authorization: Bearer token' \
--form 'logo=""AQUI CODIGO BASE 64' \
--form 'text_color="#ffffff"' \
--form 'layout_color="#000000"' \
--form 'application_texts[send_button]="firmar"' \
--form 'application_texts[open_sign_button]="entrar"' \
--form 'application_texts[open_email_button]="entrar"' \
--form 'signature_color="blue"' \
--form 'show_csv="1"' \
--form 'show_biometric_hash="1"' \
--form 'show_welcome_page="1"'\ 
--form 'templates[signatures_request]="<html>Email in HTML</html>"'\ 
¿Tiene más preguntas? Enviar una solicitud

0 Comentarios

Inicie sesión para dejar un comentario.
Tecnología de Zendesk