Integração com GetCourse

Criação e envio automático de diplomas e certificados a partir do GetCourse, após a conclusão de um treinamento ou webinar. O link para o diploma gerado será salvo nos dados do aluno no GetCourse.

Configuração do processo

Para enviar solicitações de criação de arquivos no DiMaker, você precisa configurar um processo no GetCourse. Para isso, acesse "Tarefas" - "Processos". Em seguida, clique em "Criar processo". Preencha o nome e selecione "Tipo de Objeto" - "Usuários".

Tela de criação do processo

Em seguida, no processo, selecione a aba "Processo" e, à direita, clique em "Adicionar bloco" - "Operação".

Tela de configuração do processo - adicionar URL

Na janela que aparecer, selecione "Chamar URL" (última opção) e clique em "Salvar".

Tela de configuração do processo - configurar tarefa

Esta é a tela principal. É necessário selecionar o método POST, e no campo URL insira a string de solicitação, que deve conter:

• Endereço da solicitação - https://dimaker.app/api/v1/create/?
• Token API - secure (obtido nas configurações do DiMaker)
• ID do documento - doc_id O documento usado como base para gerar o certificado ou diploma
• ID da pasta - folder_id A pasta no disco onde o arquivo será salvo
• ID do e-mail - mail_id Modelo de e-mail usado para enviar o arquivo
• Dados para substituição - cada variável deve começar com mask_

Vamos detalhar essas informações antes de mostrar o formato final da string de solicitação.

Variáveis

A solicitação precisa conter variáveis que garantam o acesso à conta no DiMaker, indiquem qual documento usar, em qual pasta no disco salvar o arquivo, etc.

As variáveis obrigatórias estão marcadas com um asterisco.

• secure*

  Token (string com 36 caracteres) obtido na página "Tokens API" do DiMaker

• doc_id*

  ID do documento (string com 36 caracteres) que será utilizado para criar o arquivo. O ID pode ser encontrado na barra de endereço quando o documento está aberto. O documento não pode estar na lixeira, mas pode estar em qualquer pasta nos Documentos.

mail_id

ID do modelo de e-mail (string com 36 caracteres) usado para envio. O ID pode ser obtido na barra de endereço quando o modelo está aberto. Se a variável não for passada, o e-mail não será enviado.

• email_send

  Hora do envio do e-mail com o arquivo. Pode assumir 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. Para um arquivo único, onfinish e oncreate são idênticos.
  timeout - Enviar e-mails após um intervalo de tempo. Nesse caso, deve-se passar mais dois parâmetros:
  email_timeout_value - valor numérico do intervalo de tempo (inteiro)
  email_timeout_unit - unidade de tempo: "m" (minutos), "h" (horas), "d" (dias).
  Outra opção é especificar o horário exato no formato UNIX no parâmetro email_timeout_timestamp. Se ambos forem fornecidos, o último prevalecerá.

• folder_id

  ID da pasta no Disco (string com 36 caracteres) para salvar os arquivos. Caso a pasta não exista, ela será criada automaticamente ao criar o primeiro arquivo.

• page_id

  Número da página (número ou string) se o documento tiver várias páginas. Pode-se passar um número (primeira página - 0) ou uma lista separada por vírgulas indicando quais páginas usar para gerar o arquivo.

• result

  Define o formato do resultado retornado. Os valores podem ser:

  • Sem valor - Uma string com os resultados da solicitação (veja abaixo) será retornada
  • link - Se a solicitação for bem-sucedida, retorna um link para o arquivo criado (ou o primeiro arquivo, se vários forem criados na mesma solicitação).
  • file - Retorna o arquivo criado (ou apenas o primeiro). O retorno ocorre após a criação completa do arquivo, o que pode demorar de 1 a 5 segundos por arquivo.

Substituição de variáveis

O documento no DiMaker deve conter ao menos uma variável a ser substituída, como %name ou %city. As variáveis devem ser escritas em letras latinas. Variáveis em cirílico, como %фио ou %класс, não são permitidas. Para endereço de e-mail, use %email.

Quando configurar o URL no processo, o nome da variável deve começar com mask_, seguido pelo nome da variável no documento. Por exemplo, se a variável no documento é %name, então no URL ela será mask_name; se for %city, será mask_city. Os dados definidos para essas variáveis serão incorporados ao documento no DiMaker ao gerar o arquivo.

Esses dados podem ser obtidos diretamente do que o GetCourse oferece. A lista completa está disponível nesta página (veja "Variáveis para o objeto ‘Usuários’"). Os valores devem ser inseridos entre chaves e ter o prefixo object., por exemplo, {object.first_name}.

Se for necessário enviar o arquivo pronto por e-mail, use a variável mask_email, com o valor {object.email}. Para nomear o arquivo, use mask_filename.

O documento pode conter diversas variáveis ao mesmo tempo. Qualquer dado do perfil do usuário no GetCourse, incluindo campos adicionais, pode ser usado no DiMaker para personalizar o documento criado.

Se desejar incluir a data atual, um número aleatório ou outros dados, consulte as funções disponíveis.

Montando a URL da solicitação

Por fim, podemos montar a URL para a tarefa. É mais prático fazer isso em um editor de texto e, em seguida, copiá-la para o campo URL na tarefa. A URL pode ter o seguinte formato (cores apenas para visualização):

Explicação da URL:

• https://dimaker.app/api/v1/create/? - endereço da solicitação
• mask_name={object.last_name}%20{object.first_name} - a variável %name no documento será substituída pelo nome e sobrenome do perfil no GetCourse. Note que um espaço entre as palavras precisa ser indicado como %20.
• mask_city={object.city} - a variável %city no documento será substituída pela cidade do perfil no GetCourse.
• mask_level={object.Уровень} - a variável %level no documento será preenchida com o campo adicional "Nível" do perfil no GetCourse.
• mask_email={object.email} - o e-mail do usuário no GetCourse.
• doc_id=b75b01cf-c732-49c6-80a0-77dd051a8299 - ID do Documento no DiMaker.
• folder_id=5a390b28-9845-4c01-b94a-7d252b115e2e - ID da pasta no Disco no DiMaker.
• mail_id=fb5eff48-4c08-4df7-a9e6-29e17896317c - ID do modelo de e-mail no DiMaker.
• secure=8453bc41-с34у-4ead-80e8-c4e76175a11b - token de segurança da API no DiMaker.

Entre as variáveis, use o caractere &. Evite espaços. Verifique cuidadosamente para garantir que a montagem esteja correta, substituindo os valores conforme necessário. Após salvar a Tarefa, conecte "Início" à "Tarefa".

Exemplo de processo no sistema

Nas configurações do DiMaker, habilite a recepção de solicitações via API e faça um teste. No GetCourse, dentro da aba "Processo", clique em "Testar", escolha a conta e marque "Executar ações de forma real". Se configurado corretamente, o arquivo do diploma ou certificado aparecerá na pasta do Disco. Caso tenha indicado mail_id, o arquivo será enviado por e-mail. Se o arquivo não for gerado, a janela de teste exibirá o motivo do erro.

Finalizando a configuração

Se tudo estiver funcionando, e o arquivo for gerado com os dados corretamente preenchidos, finalize o processo. Retorne à aba "Gerais". Na seção "Criação em Massa de Tarefas", indique "Verificação Periódica" e, em "Regra de Entrada do Objeto", defina quando a emissão do certificado deve ser acionada. Por exemplo, "Participante do Treinamento", selecione o treinamento e defina "Concluído". GetCourse verificará periodicamente quais participantes concluíram o treinamento e, se os critérios forem atendidos, iniciará o processo configurado. Nas configurações do Treinamento no GetCourse, não se esqueça de definir os critérios para considerar um treinamento como concluído. Novas tarefas serão criadas automaticamente para os participantes que atenderem às condições. Note que o GetCourse verifica os critérios a cada 5-15 minutos. Isso significa que, após a conclusão do treinamento, o certificado será enviado em até 15 minutos (as solicitações no DiMaker são processadas imediatamente).

Como garantir que apenas os novos participantes recebam o certificado, excluindo aqueles já atendidos manualmente ou via GetCourse? Na mesma seção "Regra de Entrada do Objeto", adicione outra condição clicando em "e", como "Data de Registro", especificando uma data ou grupo de participantes.

Adicionar participantes a um grupo após a emissão do certificado

Se necessário, você pode criar no GetCourse um grupo chamado "Certificado Emitido", indo em "Usuários" - "Grupos", e adicionar a esse grupo todos os usuários que receberam um certificado pelo DiMaker. Para isso, no processo, após a solicitação ao URL, adicione outro bloco de operação, "Adicionar ao grupo", e selecione o grupo desejado. Conecte a solicitação à adição ao grupo. Como resultado, após a solicitação ser executada, o usuário será adicionado ao grupo especificado.

Salvar o link do certificado no perfil do usuário

É possível salvar o link do diploma ou certificado gerado no perfil do usuário no GetCourse. Para isso, crie um campo adicional "Certificado" em "Usuários" - "Campos Adicionais" - "Adicionar Campo" - "Texto". Em seguida, no URL da solicitação no DiMaker, inclua &result=link, e abaixo, na mesma janela, selecione "Salvar resultado no campo adicional" e escolha o campo criado. Isso adicionará automaticamente o link ao perfil do usuário.

Aprovação manual de certificados

Se você deseja verificar manualmente os dados, como nome e outras informações, antes de emitir o certificado, há duas opções disponíveis:

Opção 1: No processo, na janela com a URL, marque a opção "O gerente deve confirmar a execução". Assim, o gerente terá que aprovar a execução da tarefa para um usuário específico.

Opção 2: Crie três grupos: "Aguardando Certificado", "Emitir Certificado" e "Certificado Emitido". Depois, configure dois processos. O primeiro deve ser acionado assim que o participante conclui o treinamento, adicionando-o ao grupo "Aguardando Certificado". O segundo processo deve ser configurado para enviar a solicitação ao DiMaker somente quando o participante estiver no grupo "Emitir Certificado". No mesmo processo, adicione mais duas operações: remover do grupo "Emitir Certificado" e adicionar ao grupo "Certificado Emitido". Assim, após a conclusão do curso, o participante será adicionado ao grupo "Aguardando Certificado". O gerente poderá revisar as informações e mover o participante para o grupo "Emitir Certificado". Quando a tarefa for criada, o participante será movido para o grupo "Certificado Emitido".

Outras integrações