Hércules

Árbol de páginas

  • Creado por Usuario desconocido (alicia.alvarez), modificado por última vez por Usuario desconocido (ruben.suarez) el mar 01, 2022

Estás viendo una versión antigua de esta página. Ve a la versión actual.

Comparar con el actual Ver el historial de la página

« Anterior Versión 4 Siguiente »

Config

MétodoURLParámetrosRespuestaDescripción
GET/config/time-zone
"Europe/Madrid"Devuelve una cadena con el identificador de TimeZone configurado en el módulo


EmailTpl (Email Template)

MétodoURLParámetrosRespuestaDescripción
GET/POST/emailtpls/{name}/process

Lista[EmailParam]:  La lista de parámetros

[
    {
        "name": "GENERIC_SUBJECT",
        "value": "Asunto33"
    },
    {
        "name": "GENERIC_CONTENT_TEXT",
        "value": "Contentido"
    },
    {
        "name": "GENERIC_CONTENT_HTML",
        "value": "<b color='red'>Contenido</b>"
    }
]



ProcessedEmailTpl

{
    "subject": "Asunto33",
    "contentText": "Contentido",
    "contentHtml": "<!DOCTYPE html>\n<html>\n  <head>\n    <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\" />\n  </head>\n  <body>\n    <b color='red'>Contenido</b>\n  </body>\n</html>"
}



Realiza el procesamiento de una plantilla cuyo nombre se especifica en la propia URL, aplicando los parámetros recibidos
GET/emailtpls/{name}/parametersq + s

Lista[Param]

[
    {
        "name": "GENERIC_SUBJECT",
        "description": "Asunto genérico",
        "type": "STRING"
    },
    {
        "name": "GENERIC_CONTENT_TEXT",
        "description": "Contenido textual genérico",
        "type": "STRING"
    },
    {
        "name": "GENERIC_CONTENT_HTML",
        "description": "Contenido HTML genérico",
        "type": "STRING"
    }
]
Busca/Lista los Param del email (tanto de asunto como de contenido) cuyo nombre se especifica en la propia URL
GET/emailtpls/{name}/parameters/subjectq + s

Lista[Param]

[
    {
        "name": "GENERIC_SUBJECT",
        "description": "Asunto genérico",
        "type": "STRING"
    }
]
Busca/Lista los Param que requiere la plantilla del asunto del email cuyo nombre se especifica en la propia URL
GET/emailtpls/{name}/parameters/contentq + s

Lista[Param]

[
    {
        "name": "GENERIC_CONTENT_TEXT",
        "description": "Contenido textual genérico",
        "type": "STRING"
    },
    {
        "name": "GENERIC_CONTENT_HTML",
        "description": "Contenido HTML genérico",
        "type": "STRING"
    }
]
Busca/Lista los Param que requiere la plantilla del contenido del email cuyo nombre se especifica en la propia URL

Email

MétodoURLParámetrosRespuestaDescripción
POST/emails

EmailInput

{
    "template": "GENERIC_EMAIL_TEXT",
    "recipients": [
        {
            "name": "Ruben Suarez",
            "address": "ruben.suarez@treelogic.com"
        }
    ],
    "attachments": ["sample-pdf"],
    "params": [
        {
            "name": "GENERIC_SUBJECT",
            "value": "Subject"
        },
        {
            "name": "GENERIC_CONTENT_TEXT",
            "value": "Content"
        }
    ],
    "deferrableRecipients": {
        "type": "USR",
        "url": "/pruebas/recipients",
        "method": "GET"
    }
}

EmailOutput

{
    "template": "GENERIC_EMAIL_TEXT",
    "recipients": [
        {
            "name": "Ruben Suarez",
            "address": "ruben.suarez@treelogic.com"
        }
    ],
    "attachments": [
        "sample-pdf"
    ],
    "params": [
        {
            "name": "GENERIC_SUBJECT",
            "value": "Subject"
        },
        {
            "name": "GENERIC_CONTENT_TEXT",
            "value": "Content"
        }
    ],
    "deferrableRecipients": {
        "type": "USR",
        "url": "/pruebas/recipients",
        "method": "GET"
    },
    "deferrableAttachments": null,
    "deferrableParams": null,
    "id": 2
}
Crea un Email
PUT/emails/{id}
EmailInput


{
    "template": "GENERIC_EMAIL_TEXT",
    "recipients": [
        {
            "name": "Ruben Suarez",
            "address": "ruben.suarez@treelogic.com"
        }
    ],
    "attachments": [],
    "params": [
        {
            "name": "GENERIC_SUBJECT",
            "value": "Subject2"
        },
        {
            "name": "GENERIC_CONTENT_TEXT",
            "value": "Content2"
        }
    ],
    "deferrableRecipients": {
        "type": "USR",
        "url": "/pruebas/recipients",
        "method": "GET"
    }
}

EmailOutput

{
    "template": "GENERIC_EMAIL_TEXT",
    "recipients": [
        {
            "name": "Ruben Suarez",
            "address": "ruben.suarez@treelogic.com"
        }
    ],
    "attachments": [],
    "params": [
        {
            "name": "GENERIC_SUBJECT",
            "value": "Subject2"
        },
        {
            "name": "GENERIC_CONTENT_TEXT",
            "value": "Content2"
        }
    ],
    "deferrableRecipients": {
        "type": "USR",
        "url": "/pruebas/recipients",
        "method": "GET"
    },
    "deferrableAttachments": null,
    "deferrableParams": null,
    "id": 2
}
Actualiza el Email cuyo id se especifica en la propia URL
DELETE/emails/{id}

Elimina el Email cuyo id se especifica en la propia URL
GET/emails/{id}

EmailOutput

{
    "template": "GENERIC_EMAIL_TEXT",
    "recipients": [
        {
            "name": "Ruben Suarez",
            "address": "ruben.suarez@treelogic.com"
        }
    ],
    "attachments": [
        "sample-pdf"
    ],
    "params": [
        {
            "name": "GENERIC_SUBJECT",
            "value": "Subject"
        },
        {
            "name": "GENERIC_CONTENT_TEXT",
            "value": "Content"
        }
    ],
    "deferrableRecipients": {
        "type": "USR",
        "url": "/pruebas/recipients",
        "method": "GET"
    },
    "deferrableAttachments": null,
    "deferrableParams": null,
    "id": 2
}
Recupera el Email cuyo id se especifica en la propia URL
GET/emailsq + s

Lista[EmailOutput]

[
    {
        "template": "GENERIC_EMAIL",
        "recipients": [
            {
                "name": "Hercules",
                "address": "hercules@treelogic.info"
            }
        ],
        "attachments": [
            "sample-pdf"
        ],
        "params": [
            {
                "name": "GENERIC_SUBJECT",
                "value": "Subject"
            },
            {
                "name": "GENERIC_CONTENT_TEXT",
                "value": "Content"
            },
            {
                "name": "GENERIC_CONTENT_HTML",
                "value": "Content"
            }
        ],
        "deferrableRecipients": null,
        "deferrableAttachments": null,
        "deferrableParams": null,
        "id": 1
    },
    {
        "template": "GENERIC_EMAIL_TEXT",
        "recipients": [
            {
                "name": "Ruben Suarez",
                "address": "ruben.suarez@treelogic.com"
            }
        ],
        "attachments": [],
        "params": [
            {
                "name": "GENERIC_SUBJECT",
                "value": "Subject2"
            },
            {
                "name": "GENERIC_CONTENT_TEXT",
                "value": "Content2"
            }
        ],
        "deferrableRecipients": {
            "type": "USR",
            "url": "/pruebas/recipients",
            "method": "GET"
        },
        "deferrableAttachments": null,
        "deferrableParams": null,
        "id": 2
    }
]
Busca/Lista Email
GET/emails/{id}/send

Status

{
    "message": "SENT"
}
Realiza el envía del Email cuyo id se especifica en la propia URL
  • Sin etiquetas