Endpoint
Autenticación
Authorization: Bearer <clave API>
Descripción
Devuelve una lista con todas las plantillas disponibles.
Parámetros
Nombre | Tipo | Descripción |
page | Integer | Número de página. Por defecto: 1. |
limit | Integer | Registros por página. Por defecto: 10. Máximo: 100. |
sort | String | Ordenar por: name, created_date, lastsend_date. Por defecto: created_date. |
direction | String | Ordenamiento: asc (ascendente), desc (descendente). Por defecto: desc. |
filters | String | Expresión para filtrar registros. Ver sección Generación de expresiones. |
Respuesta
Campo | Descripción |
id | ID de plantilla |
created_date | Fecha de creación (UTC+00:00) |
updated_date | Fecha de modificación (UTC+00:00) |
preview | URL de la vista previa |
name | Nombre de la plantilla |
tags | Etiquetas: authentication, confirmation, feedback, notification, others, register |
lastsend_date | Fecha del último envío (UTC+00:00) |
Errores
Error | Descripción |
malformed_filter | Expresión de filtro incorrecta |
invalid_page | Número de página incorrecto — debe ser entero positivo |
invalid_limit | Cantidad de registros incorrecta — debe ser entero positivo |
Ejemplo de respuesta
{
"page": 1,
"limit": 2,
"total": 21,
"payload": [
{
"id": "650d935447bfb73c8d03cd88",
"created_date": "2023-09-22T13:15:00+00:00",
"updated_date": "2024-01-09T18:24:59+00:00",
"name": "prueba1",
"preview": "/files/Templates/6452a270807877b0d506e2a5/template_650d935447bfb73c8d03cd88.png",
"tags": ["others"],
"lastsend_date": null
},
{
"id": "64c40fec87819d9a480428c2",
"created_date": "2023-07-28T18:58:52+00:00",
"updated_date": "2023-07-28T19:44:59+00:00",
"name": "prueba2",
"preview": "/files/Templates/6452a270807877b0d326e2a5/template_64c40fec87819d9a480428c2.png",
"tags": [],
"lastsend_date": "2023-07-28T19:44:59+00:00"
}
]
}EnvíaloSimple Transaccional — API: Generación de expresiones
La sintaxis es similar a la de MongoDB. Solo un subconjunto de operaciones está soportado.
Filtro por valor exacto:
{"nombre_del_campo": "valor"}
Ejemplo: {"name": "prueba"} devuelve registros cuyo nombre sea exactamente "prueba".
Filtro con operador:
{"nombre_del_campo": {"operador": "valor"}}
Ejemplo: {"name": {"$regex": "prueba"}} devuelve registros cuyo nombre contenga "prueba".
Operadores de comparación soportados:
Operador | Descripción |
$eq | Igual |
$neq | Distinto |
$gt | Mayor |
$gte | Mayor o igual |
$lt | Menor |
$lte | Menor o igual |
$in | Es igual a alguno de los valores indicados |
$nin | No es igual a ninguno de los valores indicados |
$regex | Expresión regular |
Filtro con casting de fecha (timestamp):
{"date": {"$gt": {"$ts": 1704974124}}}
Devuelve registros con fecha mayor al timestamp indicado.
Filtro con expresiones combinadas:
{"operador_lógico": [expresión1, expresión2]}
Ejemplo: {"$or": [{"lastsend_date": {"$eq": null}}, {"name": "prueba"}]} devuelve registros con fecha de último envío nula o con nombre igual a "prueba".
Operadores lógicos soportados:
Operador | Descripción |
$and | AND lógico |
$or | OR lógico |
$nor | OR negado |