API
Usando la API de DiMaker, puede crear archivos con datos personales y enviarlos a destinatarios si es necesario. Los accesos a la API pueden venir desde otro servidor o desde un navegador a través de la opción CORS.
Por dónde empezar
En la sección "Integración" - "Tokens API", debe obtener un token seguro para los accesos y permitir el uso de ese token. Además, debe crear un documento que contenga variables para datos personales, así como una plantilla de correo electrónico para enviar correos electrónicos y una carpeta en Drive para guardar los archivos creados.
Creación de archivos
Para crear archivos, debe enviar solicitudes POST o GET de datos a la dirección
https://dimaker.app/api/v1/create/
con los datos indicados a continuación.
La codificación debe ser UTF-8. Los campos obligatorios están marcados con un asterisco.
-
secure*
Token (cadena de 36 caracteres)
-
doc_id*
ID del documento (cadena de 36 caracteres) que se utilizará para crear el archivo. Puede obtener el ID en la barra de direcciones cuando el documento está abierto. El documento no debe estar en la papelera, pero puede estar en cualquier carpeta de Documentos.
-
mask*
Cadena JSON que contiene todas las variables para reemplazar en forma de clave (variable) - valor (texto a reemplazar). Puede contener datos para crear varios archivos (sin límite de cantidad).
Ejemplo para un solo archivo:
[{"%nombre": "Ivánov", "%puntos": "100"}]
Ejemplo para varios archivos:
[{"%nombre": "Ivánov", "%puntos": "100"}, {"%nombre": "Petrov", "%puntos": "200"}, {"%nombre": "Sidorov", "%puntos": "300"}]
Para indicar la dirección de correo electrónico, debe usar %email, para el nombre del archivo - %filename. Para enviar los archivos creados a varias direcciones de correo electrónico, debe separarlas con comas. En este caso, el estado de envío en Drive se mostrará por la primera dirección.
Solo se pueden usar comillas dobles de acuerdo con el estándar. Si el valor de la clave contiene comillas, deben escaparse.Para enviar una imagen al bloque de imagen, puede usar un enlace directo (http:// o https://) o una imagen codificada en Base64. En el segundo caso, la cadena debe comenzar con "data: image/".
Método alternativo
Si no es posible enviar una cadena JSON, puede enviar las cadenas de reemplazo como campos de solicitud. Cada variable para sustituir debe comenzar con el prefijo mask_, por ejemplo mask_name y contener el valor para reemplazar. En este caso, la variable se buscará en el documento después del prefijo. Por ejemplo, el campo mask_name corresponde a la variable %nombre. Para indicar la dirección de correo electrónico en este caso, debe utilizar mask_email y para el nombre del archivo, mask_filename. -
mail_id
ID de la plantilla de correo electrónico (cadena de 36 caracteres) para enviar por correo electrónico. Puede obtener el ID en la barra de direcciones cuando la plantilla está abierta. Si no se pasa la variable, el correo electrónico no será enviado.
-
email_send
Hora de envío del correo electrónico con el archivo. Puede tomar los siguientes valores:
onfinish - Enviar todos los correos electrónicos después de crear todos los archivos (por defecto)
oncreate - Enviar correo electrónico inmediatamente después de crear el archivo. Al crear un solo archivo, onfinish y oncreate son idénticos.
timeout - Enviar correos electrónicos después de un intervalo de tiempo. En este caso, debe pasar dos parámetros más:
email_timeout_value - valor numérico del intervalo en el que se deben enviar correos electrónicos, como número entero
email_timeout_unit - unidad de tiempo del intervalo. Puede ser "m" (minutos), "h" (horas), "d" (días).
Alternativamente, para indicar la hora exacta de envío, debe pasar el tiempo en formato unix en email_timeout_timestamp. Si se pasan timeout y email_timeout_timestamp, se dará prioridad al último. -
folder_id
ID de la carpeta en Drive (cadena de 36 caracteres) para guardar los archivos. Si no existe la carpeta, se creará automáticamente al crear el primer archivo.
-
page_id
Número de página (número o cadena) si hay varias páginas en el documento. Puede pasar un solo número (la primera página es 0) o los números (separados por comas) de las páginas que desea utilizar para crear el archivo.
-
result
D
Resultado
Como resultado, el servidor devolverá una cadena JSON con las siguientes posibles valores:
-
result
Resultado de la solicitud. Puede contener los siguientes valores:
error - error en la solicitud. Los archivos no se han creado.
success - solicitud exitosa para crear archivos. Dependiendo del escenario de uso del API, puede informar sobre la creación exitosa de archivos o mostrar un formulario para obtener los archivos. -
create_id
ID de generación. Solo en caso de solicitud exitosa. Puede ser útil para otras solicitudes API.
-
files
Una matriz que contiene los ID de los archivos creados. Solo en caso de solicitud exitosa. Para obtener el archivo en formato JPG, debe consultar https://dimaker.app/getfile/{ID}/. Para descargar el archivo PDF, debe agregar pdf/ a la URL. El API devuelve el ID del archivo de inmediato, pero se necesita tiempo para preparar los propios archivos, de 1 a 5 segundos por archivo. Antes de que el archivo se cree, la solicitud a https://dimaker.app/getfile/{ID}/ devolverá un error 404.
-
url
Cadena URL para mostrar el widget de descarga de archivos. Solo en caso de solicitud exitosa. Debe crear un Iframe con la URL proporcionada. Simplemente acceder a la URL no dará resultados. El dominio del sitio donde se obtiene el archivo debe estar correctamente especificado en la configuración del API.
La creación de cada archivo lleva 1 segundo + varios segundos para procesar todo el grupo. Inmediatamente después de enviar la solicitud, puede abrir el Iframe con la URL proporcionada. Si los archivos aún no están listos, se mostrará un mensaje correspondiente. Tan pronto como los archivos estén listos, se ofrecerá para descargarlos.
El widget de descarga se puede mostrar en una ventana emergente en la parte superior de la pantalla. Para ello, debe crear un Iframe con los siguientes estilos adicionales: position:fixed; width:100%; height:100%; top:0; bottom:0; right:0; left:0; z-index:10000; background: rgb(0 0 0 / 72%); En la barra de direcciones, debe agregar ?view=modal. Y coloque este Iframe en el body. -
error_text
Solo en caso de error. Descripción textual del error. Posibles errores: token seguro incorrecto, máscara de reemplazo equivocada, ID del documento, ID de la plantilla de la carta, ID de la carpeta en el Diccionario, o error interno del servidor.
Ejemplo de datos devueltos en caso de solicitud exitosa:
{
"result":"success",
"create_id":"b4caf05b-6757-4d9c-b4bc-1924a9b31796",
"url":"https://embed.dimaker.app/widgets/get/927ebf68-2f55-4b20-a18c-c1171ee113db/b4caf05b-6757-4d9c-b4bc-1924a9b31796/",
"files":[
"369dc61e-40c2-46c0-81f4-e31ca8c33cc2",
"d94c6efb-0076-438b-bb84-fead9c1ae556",
"716e1081-c8ee-442b-b0b0-0681b2ed5d90"
]
}Creación de varios archivos en una sola solicitud
En una sola solicitud se pueden enviar solicitudes para crear varios archivos desde diferentes documentos. Con este tipo de solicitud se pueden crear varios archivos, por ejemplo, utilizando plantillas en ruso e inglés. Enviando una sola solicitud, el servidor creará el número necesario de archivos.
Para enviar esta solicitud, la variable doc_id debe ser una matriz (el nombre de la variable es doc_id[]). En este caso, en una sola solicitud puede haber varias variables doc_id[] - para crear varios archivos. Otras variables como mail_id, email_send, folder_id también pueden ser enviadas como matrices para que cada uno de los archivos sea enviado en una plantilla específica, en un momento específico o guardado en una carpeta específica. Si no es necesario, solo la matriz doc_id debe estar presente.
Por ejemplo, si es necesario crear dos archivos de diferentes documentos y colocarlos en diferentes carpetas en Drive. Para hacer esto, es necesario enviar dos variables doc_id[] y dos variables folder_id[] (en el mismo orden). Además, si se requiere enviarlos en un solo correo electrónico, se debe especificar un mail_id y, en email_send[], primero ingresar "manual", luego "oncreate". En este caso, se creará primero un archivo y luego el segundo. Y solo después de la creación del segundo, se enviará el correo electrónico especificado en mail_id.
Enviar un archivo a uno mismo después de crearlo
El archivo se enviará por correo electrónico a la cuenta inmediatamente después de su creación. En el campo "Plantilla de correo electrónico" se puede elegir qué plantilla utilizar para el envío. Previamente en Plantillas de correo electrónico se puede crear una plantilla separada para enviar correos electrónicos a la cuenta. Si se escribe la variable %data en el texto del correo electrónico, se añadirán todos los datos del archivo en forma de tabla en ese lugar.
Otras integraciones
-