 Intégration avec GetCourse

Création et envoi automatiques de diplômes et certificats depuis GetCourse après la fin d'une formation ou d'un webinaire. Le lien vers le diplôme généré sera sauvegardé dans les données de l'élève sur GetCourse.

Création du processus

Pour envoyer des requêtes de création de fichiers à DiMaker, il est nécessaire de créer un processus dans GetCourse. Pour cela, allez dans "Tâches" - "Processus". Ensuite, cliquez sur "Créer un processus". Remplissez le nom et choisissez "Type d'objet" - "Utilisateurs".

Fenêtre de création du processus

Ensuite, dans le processus, choisissez l'onglet "Processus" et à droite, cliquez sur "Ajouter un bloc" - "Opération".

Fenêtre de création du processus - ajout d’une URL à appeler

Dans la fenêtre qui s’affiche, sélectionnez "Appeler une URL" (dernière option) et cliquez sur "Enregistrer".

Fenêtre de création du processus - fenêtre de la tâche

C'est l'espace principal. Sélectionnez la méthode POST et dans le champ URL, indiquez une chaîne de requête contenant les éléments suivants :

• Adresse de la requête - https://dimaker.app/api/v1/create/?
• Token API - secure (à obtenir dans les paramètres de DiMaker)
• ID du document - doc_id, correspondant au document à partir duquel le certificat ou diplôme sera généré
• ID du dossier - folder_id, dossier du Drive où le fichier sera enregistré
• ID du modèle d’email - mail_id, modèle d’email utilisé pour envoyer le fichier
• Données de substitution, chaque variable commençant par mask_

Nous allons examiner en détail ces éléments avant de montrer comment composer la chaîne de requête finale.

Variables

La requête doit inclure des variables qui donnent accès au compte DiMaker, spécifient quel document utiliser, où enregistrer le fichier sur le Drive, etc.

Les variables obligatoires sont marquées d'un astérisque.

• secure*

  Token (chaîne de 36 caractères) disponible sur la page "Tokens API" dans DiMaker

• doc_id*

  ID du document (chaîne de 36 caractères) à utiliser pour créer le fichier. L'ID peut être obtenu dans l'URL lorsque le document est ouvert. Le document ne doit pas être dans la corbeille, mais peut se trouver dans n'importe quel dossier.

• mail_id

  ID du modèle d'email (chaîne de 36 caractères) pour l'envoi par email. L'ID peut être trouvé dans l'URL lorsque le modèle est ouvert. Si la variable n'est pas transmise, aucun email ne sera envoyé.

• email_send

  Moment d'envoi de l'email avec le fichier. Valeurs possibles :
  onfinish - Envoyer tous les emails après la création de tous les fichiers (par défaut)
  oncreate - Envoyer les emails dès que le fichier est créé. Pour un fichier unique, onfinish et oncreate sont identiques.
  timeout - Envoyer les emails après un certain délai. Si vous optez pour cette solution, indiquez deux autres paramètres :
  email_timeout_value - valeur du délai en nombre entier
  email_timeout_unit - unité de mesure du délai. Peut prendre les valeurs "m" (minutes), "h" (heures), "d" (jours).
  Sinon, pour indiquer un moment précis, passez une heure en format UNIX time dans email_timeout_timestamp. Si timeout et email_timeout_timestamp sont transmis, ce dernier sera prioritaire.

• folder_id

  ID du dossier dans le Drive (chaîne de 36 caractères) où enregistrer les fichiers. Si le dossier n'existe pas, il sera créé automatiquement pour le premier fichier.

• page_id

  Numéro de la page (numérique ou chaîne), si le document a plusieurs pages. Transmettez un numéro unique (première page - 0) ou plusieurs numéros (séparés par des virgules).

• result

  Précise sous quelle forme renvoyer le résultat. Valeurs possibles :

  • Absence de valeur. Retourne une chaîne avec le résultat de la requête (voir ci-dessous).
  • link. En cas de succès, retourne un lien vers le fichier créé (ou le premier fichier s’il y en a plusieurs). Pour accéder au fichier, suivez ce lien. La génération des fichiers peut prendre entre 1 et 5 secondes. Tant que le fichier n’est pas prêt, une erreur 404 sera renvoyée pour cette URL. Si la requête n’a pas abouti, une chaîne d’erreur sera renvoyée.
  • file. Retourne directement le fichier créé (ou le premier en cas de plusieurs fichiers). Comme la création prend quelques secondes, la réponse inclura directement le fichier. Si le fichier n'est pas généré en moins de 30 secondes, une erreur 404 sera renvoyée. Cette méthode est déconseillée pour des requêtes fréquentes (plus d'une toutes les 5 secondes).

Variables dans le document

Le document DiMaker doit contenir au moins une variable comme %name ou %city écrite en lettres latines. Les caractères cyrilliques comme %name ou %класс ne sont pas autorisés. Pour une adresse email, utilisez %email.

Pendant la création de l’URL dans le processus, les noms des variables doivent commencer par le mot mask_, suivi de la variable présente dans le document. Par exemple, si le document contient %name, utilisez mask_name. Si c’est %city, alors utilisez mask_city. Les valeurs de ces variables seront envoyées au document lorsque DiMaker générera le fichier.

Les données peuvent être extraites depuis GetCourse et le détail des champs disponibles est listé sur cette page (section "Variables par objet « Utilisateurs »").

Le format des valeurs doit être entre accolades avec le préfixe object. Par ex. : {object.first_name}.

Pour envoyer le fichier par email, utilisez la variable mask_email avec la valeur {object.email}, ou utilisez mask_filename pour définir un nom de fichier spécifique.

Il est possible d’inclure autant de variables que nécessaire dans le document. Toutes les données du profil utilisateur GetCourse (y compris les champs personnalisés) peuvent être utilisées pour personnaliser le fichier final.

Pour des données comme la date actuelle, un numéro aléatoire ou tout autre élément, utilisez les fonctions.

Autres intégrations