Integración con GetCourse
Automatización de la creación y envío de diplomas y certificados desde GetCourse después de completar un entrenamiento o seminario web. El enlace al diploma completo se guardará en los datos del estudiante en GetCourse.
Creación del proceso
Para enviar solicitudes de creación de archivos a DiMaker, es necesario crear un proceso en GetCourse. Para ello, abra "Tareas" - "Procesos". A continuación, seleccione "Crear proceso". Complete el nombre y seleccione "Tipo de objeto": "Usuarios".
Ventana de creación de proceso
Ventana de creación de proceso: agregar llamada URL
En la ventana que aparece, seleccione "Llamar URL" (el último elemento) y haga clic en "Guardar".
Ventana de creación de proceso: ventana de tarea
Esta es la ventana principal. Seleccione el método POST y en el campo URL, indique la cadena de solicitud, que debe contener:
- Dirección de solicitud - https://dimaker.app/api/v1/create/?
- Token API - secure (tomado de la configuración en DiMaker)
- ID de documento - doc_id. Documento en base al cual se emitirá el certificado o diploma.
- ID de carpeta - folder_id. Carpeta en el disco en la que se colocará el archivo.
- ID de correo electrónico - mail_id. Plantilla de correo electrónico que se utilizará para enviar el archivo.
- Datos de reemplazo, cada variable que comience con mask_
Primero, examinaremos todos estos datos en detalle y luego, cómo debe verse la cadena de solicitud al final.
Variables
The Zapier app should have variables that provide access to the DiMaker account, specify which document to use, in which folder to save the file in Google Drive, and so on.
Required form variables are marked with an asterisk.
-
secure*
The token (36-character string) from the "API Tokens" page in DiMaker.
-
doc_id*
The ID of the document (36-character string) that will be used to create the file. The ID can be obtained from the address bar when the document is open. The document must not be in the trash, but can be in any folder in Documents.
-
mail_id
The ID of the email template (36-character string) to send by email. The ID can be obtained from the address bar when the template is open. If the variable is not provided, the email will not be sent.
-
email_send
The time to send the email with the file. Can take the following values:
onfinish - Send all emails after creating all files (default value)
oncreate - Send emails immediately after creating the file. When creating a single file, onfinish and oncreate are identical.
timeout - Send emails after a period of time. In this case, two more parameters must be passed:
email_timeout_value - a numeric value of the time interval to send emails, an integer value
email_timeout_unit - the unit of measurement of the time interval. Can take the value "m" (minutes), "h" (hours), "d" (days).
Alternatively, to specify the exact time for sending, the time in Unix time format must be passed in email_timeout_timestamp. If timeout and email_timeout_timestamp are passed, the latter has priority. -
folder_id
The ID of the folder in Google Drive (36-character string) to save the files. If the folder does not exist, it will be created automatically when the first file is created.
-
page_id
The sequence number of the sheet (number or string) if the document has multiple sheets. You can pass one number (first sheet - 0) or numbers (comma separated) of sheets to be used to create the file.
-
result
Determines how to return the result. Can take the following values:
- Not provided. A JSON string with the result of the Zapier app will be returned (see below).
- link. If the Zapier app is successful, a string containing a link to the created file will be returned (if multiple files were created in the Zapier app, only the link to the first one will be returned). To get the actual file, you need to follow the link provided. It takes time to prepare the files themselves - from 1 to 5 seconds per file. Before the file is created, the Zapier app at this address will return a 404 error. If the Zapier app does not result in the creation of a file, a JSON string with an error will be returned (see below).
- file. If the Zapier app is successful, the actual file will be returned (if multiple files were created in the Zapier app, only the first one will be returned). Since file creation takes 1-5 seconds, the return will only happen after the file has been created. When there are many Zapier apps to the API, the time to create the file will increase. If the file is not prepared within 30 seconds, the API will return a 404 error (although the Zapier app to create the file will eventually be executed). If it is expected that there will be more Zapier apps to the API than one Zapier app in 5 seconds, this parameter should not be used.
Variables
There should be at least one variable in the DiMaker document, such as %name or %city. The variable should be written in Latin script. Cyrillic variables such as %фио or %класс cannot be used. The email address should be %email.
When composing a URL in processes, the variable name should start with the word mask_, followed by the variable from the Document. For example, if the document has a variable %name, the variable name in the URL should be mask_name, and if the document has a variable %city, the variable name should be mask_city. The data specified for these variables will be delivered to the Document in DiMaker when a file is created.
The data itself can be taken from what GetCourse provides; the list can be found on this page under the subtitle "Variables by Object 'Users'". The value should be in curly braces, prefixed with object., for example {object.first_name}.
If it is necessary to send a ready-made file by email, the variable mask_email should be used, with the value {object.email}. If a name for the ready-made file is specified, the variable name should be mask_filename.
There can be any number of such variables in the document. Any data from the user's profile in GetCourse, including additional fields, can be passed to DiMaker and then applied to the ready-made file.
If you need to insert the current date, a random number, or other data, functions should be used.
Composing the Request URL
Now it is possible to compose the URL for the Task. It is better to do this in any editor, and then copy it to the URL field in the Task. The URL request may look like this (colors are for convenience):
Let's break down the string step by step:
- https://dimaker.app/api/v1/create/? - the request address
- mask_name={object.last_name}%20{object.first_name} - the first and last name from the profile in GetCourse will be substituted into the %name variable in the document. Note that a space is required between the first and last name. It is represented by %20.
- mask_city={object.city} - the city from the profile in GetCourse will be substituted into the %city variable in the document
- mask_level={object.Уровень} - the value from the "Level" additional field from the profile in GetCourse will be substituted into the %level variable in the document
- mask_email={object.email} - the visitor's email address from their profile in GetCourse
- doc_id=b75b01cf-c732-49c6-80a0-77dd051a8299 - DiMaker Document ID
- folder_id=5a390b28-9845-4c01-b94a-7d252b115e2e - folder ID in DiMaker's Disk
- mail_id=fb5eff48-4c08-4df7-a9e6-29e17896317c - email template ID in DiMaker
- secure=8453bc41-с34у-4ead-80e8-c4e76175a11b - DiMaker's API secret code
& is used between variables. Spaces cannot be used. The string must be composed very carefully, with your own data substituted, ensuring that not a single character is lost. After saving the Task, connect "Start Working" and the "Task."
Create Process Window - Process
To receive API requests, API reception settings must be enabled in DiMaker and then testing must be performed. To do this, in the Process section in GetCourse, click "Test", select your account, and check the box "Perform actions for real." If everything is correct, a diploma or certificate file will appear in the folder on DiMaker's Disk. If you specified mail_id, the file will be sent to the email address. If the file does not appear, the reason why the request did not execute will be specified in the testing window.
Finalización de la configuración del proceso
Si la prueba ha sido exitosa, el archivo se ha creado y todos los datos se han completado, puede finalizar la configuración del proceso. Para ello, vuelva a la pestaña "Principal". En el panel de "Creación masiva de tareas", seleccione "Comprobación periódica" y en "Regla de entrada de objeto", seleccione cuándo activar el proceso de emisión de certificado. Por ejemplo, "Participante en el curso", elija qué curso y "completado". Como resultado, GetCourse revisará a todos los visitantes que hayan completado el curso específico, y si es así, iniciará el proceso especificado. En la configuración del curso en GetCourse, asegúrese de indicar cuando se considera que el curso ha finalizado. Después de iniciar el proceso, se agregarán nuevas tareas para aquellos visitantes que cumplan con los criterios de búsqueda. Tenga en cuenta que GetCourse realiza una verificación cada 5-15 minutos. Esto significa que si el visitante completa el curso, recibirá el certificado dentro de los 15 minutos (DiMaker procesa los prerequisitos de inmediato).
¿Cómo evitar que todos los visitantes actuales que ya hayan recibido un certificado a través de GetCourse o manualmente sean incluidos en el proceso? En "Regla de entrada de objeto", agregue otra condición, presionando "y", y, por ejemplo, "Fecha de registro", especifique la fecha requerida o el grupo del visitante.
Agregar a un grupo después de emitir el certificado
Si es necesario, en GetCourse puede crear un grupo "Certificado emitido", en "Usuarios" - "Grupos" y agregar a todos los usuarios a este grupo que hayan recibido un certificado a través de DiMaker. Para hacer esto, en el proceso, después de completar la tarea de URL, agregue otro bloque, operación, "Agregar al grupo" y especifique este grupo. Luego, vincule la tarea de URL y la adición al grupo. Como resultado, después de completar la tarea, el visitante se agregará al grupo necesario.
Guardar el enlace al certificado en el perfil del usuario de GetCourse
Si es necesario, en GetCourse, puede guardar el enlace al diploma o certificado en el perfil del usuario al que se le otorgó el certificado. Para hacer esto, agregue un campo adicional "Certificado" en "Usuarios" - "Campos adicionales" - "Agregar campo" - "Cadena". Luego, en la tarea de URL en DiMaker, agregue &result=link, y debajo en la misma ventana, "Escribir el resultado en el campo adicional" y seleccione este campo. Como resultado, después de completar la tarea, el enlace al diploma se agregará al perfil del visitante.
Aprobación manual de la emisión de certificados
Si desea verificar manualmente el nombre u otros datos antes de emitir un certificado, puede hacerlo de dos maneras.
Método 1: en el proceso, en la ventana de URL, marque la casilla "El administrador debe aprobar el inicio". Como resultado, el administrador deberá aprobar la tarea de un visitante específico antes de que se emita el certificado.
Método 2: cree tres grupos "Esperando el certificado", "Emitir certificado" y "Certificado emitido". Luego, en los procesos, agregue dos procesos. El primer proceso debe activarse cuando un visitante completa el curso y debe agregarse al grupo "Esperando el certificado", y el segundo proceso es la tarea de URL en DiMaker, siempre que el visitante esté en el grupo "Emitir certificado". En el mismo proceso, debe agregar dos operaciones más: eliminar del grupo "Emitir certificado" y agregar al grupo "Certificado emitido". Como resultado, después de completar el curso, el visitante se agregará al grupo "Esperando certificado", luego el administrador deberá verificar todos los datos y mover al visitante al grupo "Emitir certificado". Una vez que se crea la tarea, el visitante se moverá al grupo "Certificado emitido".