Formulário de Criação
Criação automática de arquivos no seu site - diplomas, certificados ou outros documentos. Os visitantes do seu site apenas precisam preencher o formulário e receber o arquivo.
Para criar os arquivos, é necessário construir um formulário HTML no seu site. Se isso não for possível, utilize simplesmente o widget de criação.
Criando o Formulário
Para enviar solicitações de criação de arquivos para o DiMaker, você precisa criar um formulário no seu site. Este formulário pode estar disponível tanto na área pública como na área restrita do seu site. Use seu CMS para criar uma página e adicionar o formulário.
Ação do Formulário
https://dimaker.app/api/v1/webform-create/
Campos do Formulário
Você precisará adicionar alguns campos ocultos com os seguintes valores:
-
secure*
Token (string com 36 caracteres)
-
doc_id*
ID do documento (string com 36 caracteres) que será usado para criar o arquivo. O ID pode ser obtido na barra de endereço ao abrir o documento. O documento não deve estar na lixeira, mas pode estar em qualquer pasta dos Documentos.
-
mail_id
ID do modelo de e-mail (string com 36 caracteres) para envio por e-mail. O ID pode ser obtido na barra de endereço ao abrir o modelo. Se esta variável não for fornecida, o e-mail não será enviado.
-
email_send
Momento para 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 os e-mails imediatamente após a criação do arquivo. Ao criar apenas um arquivo, onfinish e oncreate são equivalentes.
timeout - Enviar os e-mails após determinado intervalo de tempo. Neste caso, deve-se passar dois parâmetros adicionais:
email_timeout_value - valor numérico do intervalo de tempo para envio, um número inteiro
email_timeout_unit - unidade de medida do intervalo de tempo. Pode ser "m" (minutos), "h" (horas) ou "d" (dias).
Alternativamente, para especificar um horário exato de envio, é possível passar o timestamp em unix time no email_timeout_timestamp. Caso sejam enviados timeout e email_timeout_timestamp, o último terá prioridade. -
folder_id
ID da pasta no Disco (string com 36 caracteres) em que os arquivos serão salvos. Se a pasta não existir, ela será criada automaticamente ao criar o primeiro arquivo.
-
page_id
Número da página (número ou string) caso o documento possua várias páginas. Pode-se passar o número de uma única página (primeira página = 0) ou os números das páginas (separados por vírgulas) que devem ser usadas para criar o arquivo.
Enviar o arquivo para você após a criação
O arquivo será enviado para o e-mail da conta imediatamente após ser criado. No campo "Modelo de E-mail", você pode selecionar qual modelo usar para o envio. Previamente, você pode criar um modelo específico na seção de Modelos de E-mail. Caso insira a variável %data no corpo do e-mail, todas as informações do arquivo serão adicionadas como uma tabela nesse local.
Scripts e Estilos
Na página de integração, copie o código e insira-o no elemento HEAD ou em qualquer outra parte da página. Não é necessário inserir este código em todas as páginas do site, apenas na página com o formulário.
Além disso, você precisa criar dois blocos com os IDs result-success e result-danger. Ambos devem estar inicialmente ocultos com o estilo display:none; No primeiro bloco, você pode adicionar um texto informando a criação bem-sucedida do arquivo. Este bloco será exibido após uma solicitação bem-sucedida. Caso ocorra algum erro, o bloco com o ID result-danger será exibido, e a mensagem de erro será automaticamente inserida nesse bloco.
Substituições no Documento
No documento, deve haver pelo menos uma variável a ser substituída, como %name ou %course. Adicione no formulário um campo cujo nome da variável comece com mask_, como mask_name ou mask_course. Os dados fornecidos pelo visitante nesses campos serão substituídos pelas variáveis correspondentes no conteúdo do documento. Para especificar um endereço de e-mail, utilize a variável mask_email. Para enviar e-mails para múltiplos endereços, separe-os por vírgulas ou espaços. Nesse caso, o status do 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 o seu funcionamento. Um arquivo será criado e exibido em uma janela pop-up para download.
Um Documento = Uma Submissão
Opcionalmente, você pode limitar a quantidade de submissões por formulário. Caso já tenha sido criado um arquivo para o e-mail especificado com o doc_id, será exibida uma mensagem informando que somente um arquivo pode ser gerado.
Meus Documentos
Você pode exibir os documentos de um usuário na área restrita do seu site. Para isso, crie um formulário conforme descrito anteriormente. Em seguida, adicione os campos ocultos email, secure e doc_id. No primeiro, insira o endereço de e-mail do visitante, e no último, utilize o valor all. Ao acessar essa página, o visitante verá uma lista de todos os documentos associados ao e-mail, com a opção de fazer download. Se desejar que o arquivo do visitante seja exibido automaticamente ao invés do formulário, o campo email deverá ser oculto e preenchido automaticamente pelo seu CMS.