Las secciones personalizadas (también referenciadas como custom_elements) son una forma de añadir contenido personalizado adicional en el recibo. Esto puede ser interesante si deseas añadir un mensaje personalizado para un cliente específico, o si quieres informar, por ejemplo, de una oferta.
Una sección personalizada puede ser de varios tipos:
- TEXTO (TEXT)
Para obtener más información sobre las secciones personalizadas de TEXTO y cómo utilizarlas, echa un vistazo a este artículo.
- IMAGEN (IMAGE)
Para más información sobre las secciones personalizadas de IMAGEN y cómo utilizarlas, échale un vistazo a este artículo. - CÓDIGO QR (QR_CODE)
Para más información sobre las secciones personalizadas de CÓDIGO QR y cómo utilizarlas, consulta este artículo. - CÓDIGO DE BARRAS (BAR_CODE)
Para más información sobre las secciones personalizadas de CÓDIGO DE BARRAS y cómo utilizarlas, consulta este artículo.
La posición de las secciones personalizadas en el recibo se define mediante los parámetros orientación (orientation) y posición (position). La posición hace referencia a una sección de recibo cercana y orientación se refiere a la orientación relativa de la sección de recibo.
¿Cómo añadir secciones personalizadas?
Se pueden añadir secciones personalizadas para cada recibo individualmente, lo que resulta útil para los mensajes únicos. Las secciones personalizadas únicas se añaden directamente a través de la llamada a la API (schema.ekabs_v0.custom_elements) al crear un recibo.
Las secciones personalizadas también pueden configurarse como predeterminadas para un periodo de tiempo específico, lo que resulta útil para los mensajes genéricos. Las secciones personalizadas predeterminadas pueden configurarse a través de la API, o a través de la interfaz de usuario del merchant dashboard. Recomendamos invitar a los comerciantes como colaboradores a su organización en el dashboard, para que puedan configurar las secciones personalizadas ellos mismos, y no requiera la intervención del proveedor del TPV.
¿Cómo añadir una sección personalizada a través de la API?
- Elige el tipo de sección personalizada que deseas añadir: TEXT, IMAGE, QR_CODE, o BAR_CODE
- Haz un array de objetos de CustomElements, donde el objeto contiene los siguientes datos:
{
"alignment": "TEXT",
"content": CustomElementContent | CustomMediaContent,
"orientation": "BEFORE",
"position": "HEAD",
} - El contenido (content) puede ser CustomElementContent o CustomMediaContent, que se compone de los siguientes campos de datos:
CustomElementContent {
"data": "string",
"encoding": "CODE128",
"type": "BAR_CODE"
}
CustomMediaContent {
"alt_text": "string",
"label": "string",
"label_alignment": "ABOVE",
"media_id": "00000000-0000-0000-0000-000000000000",
"media_location": "string",
"type": "IMAGE"
} - Para más detalles sobre cómo crear secciones personalizadas de tipo IMAGEN, puedes consultar este artículo.
- Agrega el objeto construido al array en schema.ekabs_v0.custom_elements
- Para crear el recibo, utilice el endpoint CreateReceipt
¿Cómo añadir una sección personalizada a través del dashboard?
1. Selecciona la pestaña Sections del Receipt Builder en la barra de navegación de la parte izquierda de la pantalla.
2. Para añadir una sección personalizada, haz clic en el icono + situado a la derecha de la pantalla.
3. Se añadirá una sección personalizada del tipo seleccionado en su ubicación predeterminada en el recibo.
4. Configura la sección personalizada en el editor de la parte derecha de la pantalla. Por ejemplo, sube una imagen.
5. Guarda y aplica los cambios configurados pulsando el botón Apply en la esquina superior derecha de la pantalla. Sugerencia: Debes aplicar los cambios dos veces. Una vez para aplicar los cambios de la sección personalizada, y otra vez para establecer la sección personalizada configurada como predeterminada para tus recibos.