Formulário de Criação
Criação automática de arquivos no seu site - diplomas, certificados ou outros documentos. O visitante do seu site só precisará preencher um formulário para receber o arquivo.
Para gerar arquivos, é necessário criar um formulário HTML no seu site. Se isso não for possível, utilize o widget de criação.
Criação do Formulário
Para enviar solicitações de criação de arquivos para o DiMaker, você precisa configurar um formulário no seu site. Este formulário pode estar localizado em uma área pública ou restrita do seu site. Utilize seu CMS para criar a página e o formulário.
Ação do Formulário
https://dimaker.app/api/v1/webform-create/Campos do Formulário
É necessário criar alguns campos ocultos com os seguintes valores:
-
secure*
Token (string, 36 caracteres)
-
doc_id*
ID do documento (string, 36 caracteres) que será usado na criação do arquivo. O ID pode ser obtido na barra de endereço quando o documento aberto. Ele não deve estar na lixeira, mas pode estar em qualquer pasta de Documentos.
-
mail_id
ID do modelo de e-mail (string, 36 caracteres) para envio por e-mail. O ID pode ser obtido na barra de endereço quando o modelo está aberto. Se o campo não for enviado, o e-mail não será enviado.
-
email_send
Horário de envio do e-mail com o arquivo. Pode ter os seguintes valores:
onfinish - Enviar todos os e-mails após a criação de todos os arquivos (padrão)
oncreate - Enviar e-mails imediatamente após a criação do arquivo. Ao criar um arquivo, onfinish e oncreate são idênticos.
timeout - Enviar e-mails após um intervalo de tempo. Nesse caso, é necessário fornecer mais dois parâmetros:
email_timeout_value - valor numérico do intervalo para o envio dos e-mails, em inteiro
email_timeout_unit - unidade de tempo do intervalo. Pode ser "m" (minutos), "h" (horas), "d" (dias).
Alternativamente, para especificar uma hora exata de envio, forneça o horário no formato unix time em email_timeout_timestamp. Caso sejam fornecidos timeout e email_timeout_timestamp, o segundo terá prioridade. -
storage_period
Período de armazenamento dos arquivos no Disco. Se o parâmetro não for especificado, os arquivos serão armazenados indefinidamente até serem excluídos manualmente. Para exclusão após um intervalo de tempo, deve-se indicar o valor:
timeout. Nesse caso, é necessário passar também dois parâmetros:
storage_period_timeout_value - valor numérico do intervalo para exclusão dos arquivos, em inteiro
storage_period_timeout_unit - unidade de tempo do intervalo. Pode ser "m" (minutos), "h" (horas), "d" (dias).
Ou, para indicar um horário exato de exclusão, deve-se fornecer o horário no formato unix time em storage_period_timeout_timestamp. Se forem fornecidos storage_period_timeout_value e storage_period_timeout_timestamp, o último terá prioridade. -
folder_id
ID da pasta no Disco (string, 36 caracteres) onde os arquivos serão salvos. Se a pasta não existir, ela será criada automaticamente após a criação do primeiro arquivo.
-
page_id
Número da página (número ou string), se o documento contiver várias páginas. Pode-se passar um número único (primeira página - 0) ou números (separados por vírgula) das páginas a serem usadas na criação do arquivo.
Enviar arquivo para sua conta após a criação
O arquivo será enviado ao e-mail da conta assim que for criado. No campo "Modelo de E-mail" é possível escolher qual modelo será usado para o envio. Nos Modelos de E-mail é possível criar um modelo específico para enviar e-mails para sua conta. Se no texto do e-mail você incluir a variável %data, todas as informações do arquivo serão inseridas nesse local na forma de uma tabela.
Script e estilos
Na página de integração obtenha o código e insira no HEAD ou em qualquer outra parte da página. Não é necessário incluir este código em todas as páginas do site. Deve-se apenas inseri-lo na página contendo o formulário.
Além disso, é necessário criar dois blocos com id result-success e result-danger. Ambos os blocos são ocultos, com o estilo display:none; No primeiro bloco pode-se escrever um texto informando a criação bem-sucedida do arquivo. Este bloco será mostrado em caso de sucesso no envio. Se ocorrer um erro, o bloco result-danger será exibido automaticamente contendo o texto da falha.
Substituição no documento
No documento, deve haver pelo menos uma variável para substituição, por exemplo %name ou %course. No formulário, adicione um campo cujo nome comece com mask_, por exemplo, mask_name ou mask_course. Os dados inseridos pelo visitante nesses campos serão substituídos pelas variáveis correspondentes no texto do documento. Para especificar o endereço de e-mail, use a variável mask_email. Para enviar e-mails para vários endereços, liste-os separados por vírgulas ou espaços. O status de envio no Disco será exibido para o primeiro endereço.
Funcionamento do formulário
Após criar o formulário, você pode abrir a página publicada e testar seu funcionamento. Um arquivo será criado e exibido em uma janela pop-up para download.
Um documento = um preenchimento
Opcionalmente, você pode limitar o número de preenchimentos do formulário. Caso um arquivo já tenha sido criado com o doc_id para o e-mail especificado, uma mensagem será exibida informando que apenas um arquivo pode ser criado.
Meus documentos
Você pode listar os documentos de uma pessoa em uma área restrita do seu site. Para isso, crie um formulário conforme descrito acima e inclua campos ocultos de email, secure e doc_id. No primeiro, o endereço de e-mail do visitante, e no último campo insira o valor all. Ao abrir a página, o visitante verá a lista de todos os documentos no local do formulário, com a opção de baixá-los. Se desejar que o visitante veja seu arquivo caso já tenha preenchido o formulário, o campo email do formulário deve estar oculto e ser populado automaticamente pelo seu CMS.