Guía rápida de como iniciar el API

Les presentamos la documentación API de la herramienta File Builder donde podrá ver en detalle los distintos endpoints y formas de respuesta.

La función principal de la API es permitirte generar pdf y thumbnail a través de código html, para esto sólo se debe seguir los siguientes pasos:

• Escriba el código html y genere su archivo
• Descargue su archivo

Autenticación

Labs

Requerido: Api Key

Prod

Requerido: Api key

Formato

API-rest.

Códigos de respuesta

Para las respuestas positivas tenemos el código 200, las respuestas de error 400 y 500.

EndPoints V1

Post /pdf

Este recurso te permite crear un archivo PDF a partir de un código HTML. También tienes la opción de descargar el contenido desde una URL o directamente.

With hmtl

{
   "data":{
      "usuario":"<strong>Cliente Importante</strong>",
      "adjunto":"8275",
      "carta-jefe":"<div>Esto es un pdf.</div>"
   },
   "html":"<div>Esto es un pdf.</div>",
   "password":null,
   "pdfId":"1234567890123456",
   "absolute_path":"/tmp/cosa.pdf",
   "folder":"Prueba",
   "options":{
      "encoding":"UTF-8"
   },
"idClient" : 1,
   "metadata":{
      "emailJobId":"5c1b2fcf0044737efcb29fbc"
   }
}

With url

{
  "data": {
    "usuario": "<strong>Cliente Importante</strong>",
    "adjunto": "8275",
    "carta-jefe": "<div>Esto es {{adjunto}} un pdf.</div>"
  },
"idClient" : 1,
   "url":"<https://masivapp.com/ViewInBrowser/Index?idPackage=9005008&tag=MASIVC89A29293E6C&idSend=2&utm_campaign=website&utm_source=Masiv&utm_medium=Email>",
  "password": "null",
  "options": { "encoding": "UTF-8" },
  "metadata": { "emailJobId": "5c1b2fcf0044737efcb29fbc" }
}

data: (Tipo de objeto) - (Opcional) Se refiere a los valores para los campos de reemplazo dentro del HTML. url: (Tipo de cadena) Se refiere a una URL que contiene el HTML para renderizar. html: (Tipo de cadena) Se refiere a la cadena de HTML para renderizar. password: (Tipo de cadena o entero) - (Opcional) Contraseña del archivo a generar (Opcional). options: (Tipo de objeto) - (Opcional) Se refiere a las opciones de configuración para el renderizado. metadata: (Tipo de objeto) - (Opcional) Datos adicionales que deseas enviar en la solicitud.

Generar PDF y enviar webhook.

Actualmente enviamos el webhook a través de API, SQS o RabbitMQ.

{
    "data": {
      "usuario": "<strong>Cliente Importante</strong>",
      "adjunto": "8275",
      "carta-jefe": "<div>Esto es un pdf.</div>"
    },
    "password" : "1234",
"idClient" : 1,
    "html": "<div>Esto es un pdf.</div>",
    "options": {
      "encoding": "UTF-8",
      "zoom": 1
    },
    "hook": "<https://testpdf.requestcatcher.com/test>",
    "metadata": { "emailJobId": "5c1b2fcf0044737efcb29fbc" }
  }

hook: (Tipo de cadena) - (Requerido) Este campo se refiere a la dirección donde se entregará el mensaje.

nota: la URL de RabbitMQ siempre debe estar codificada en base64.

token: (Tipo de cadena) - (Opcional) En caso de que la API requiera un token.

Al enviar a través de RabbitMQ, se deben agregar las siguientes claves:

queue_name: (Tipo de cadena) - (Requerido) nombre de la cola de destino.

routing_key: (Tipo de cadena) - (Requerido)

exchange: (Tipo de cadena) - (Requerido)

Respuesta:

Código de Estado: 200

{
    "id": "idPdf",
    "filepath": "filepath"
}

Código de Estado: 400, 500

{
    "statusCode": statusCode,
    "headers": {
        "Access-Control-Allow-Origin": "*"
    },
    "body": "{\\"status\\": \\"message\\"}"
}

Post /thumbnail