Integratie met GetCourse
Automatisch creëren en verzenden van diploma's en certificaten vanuit GetCourse na voltooiing van een training of webinar. De link naar het voltooide diploma wordt opgeslagen in het profiel van de deelnemer in GetCourse.
Aanmaken van een proces
Om verzoeken voor het genereren van bestanden in DiMaker te verzenden, moet er een proces worden aangemaakt in GetCourse. Ga hiervoor naar "Taken" - "Processen". Klik vervolgens op "Proces aanmaken". Vul een naam in en kies bij "Objecttype" voor "Gebruikers".
Venster voor het maken van een proces
Ga vervolgens in het proces naar het tabblad "Proces" en klik aan de rechterkant op "Blok toevoegen" - "Operatie".
Proces aanmaken - URL-aanroep toevoegen
In het venster dat verschijnt, selecteer "URL aanroepen" (de laatste optie) en klik op "Opslaan".
Proces aanmaken - taakvenster
Dit is het hoofdvenster. Kies de methode POST, en vul bij de URL het verzoekpad in dat de volgende gegevens bevat:
- Verzoekadres - https://dimaker.app/api/v1/create/?
- API-token - secure (te vinden in de instellingen van DiMaker)
- Document-ID - doc_id Het document op basis waarvan het certificaat of diploma wordt gegenereerd
- Map-ID - folder_id De map in de opslag waar het bestand wordt opgeslagen
- Email-ID - mail_id Sjabloon voor de e-mail waarmee het bestand wordt verstuurd.
- Vervangingsgegevens, elke variabele begint met mask_
Bekijk eerst deze gegevens in detail, en daarna bespreken we hoe de uiteindelijke verzoek-URL eruit moet zien.
Variabelen
In het verzoek moeten variabelen worden opgenomen die toegang geven tot het DiMaker-account, aangeven welk document moet worden gebruikt, waar het bestand moet worden opgeslagen, enzovoorts.
Verplichte velden zijn gemarkeerd met een sterretje.
-
secure*
API-token (36 tekens) te vinden op de pagina "API-tokens" in DiMaker
-
doc_id*
ID van het document (36 tekens) dat wordt gebruikt om het bestand te genereren. Dit ID kun je vinden in de adresbalk als het document is geopend. Het document mag niet in de prullenbak liggen maar kan in elke map met documenten staan.
-
email_send
Het moment waarop de e-mail met het bestand wordt verstuurd. Kan de volgende waarden aannemen:
onfinish - Verstuur alle e-mails nadat alle bestanden zijn aangemaakt (standaard).
oncreate - Verstuur de e-mails onmiddellijk nadat een bestand is aangemaakt. Bij één bestand zijn onfinish en oncreate gelijk.
timeout - Verstuur e-mails na een bepaalde tijd. In dit geval moet je nog twee parameters opgeven:
email_timeout_value - getal dat de tijdsperiode aangeeft na hoeveel tijd de e-mails moeten worden verstuurd.
email_timeout_unit - eenheid van de tijdsperiode: "m" (minuten), "h" (uren), "d" (dagen).
Of geef een specifieke tijd aan in UNIX-tijd met email_timeout_timestamp. Als zowel timeout als email_timeout_timestamp worden opgegeven, heeft email_timeout_timestamp voorrang. -
folder_id
De ID van de map in de DiMaker-opslag waar de bestanden worden bewaard. Als de map niet bestaat, wordt deze automatisch aangemaakt zodra het eerste bestand is aangemaakt.
-
page_id
Het nummer van het documentblad (als er meerdere zijn) dat gebruikt moet worden, bijvoorbeeld het eerste blad is 0. Je kunt meerdere bladnummers doorgeven, gescheiden door komma's.
-
result
Bepaalt hoe het resultaat moet worden teruggegeven. Waarden kunnen zijn:
- Niets opgegeven. Er wordt een -string met de resultaten teruggestuurd.
- link. Geeft een link naar het aangemaakte bestand terug. Bij meerdere bestanden wordt alleen de eerste link gegeven.
- file. Geeft het eerste aangemaakte bestand direct terug. Dit duurt meestal 1-5 seconden. Bij veel verzoeken kan de wachttijd oplopen.
mail_id
ID van het e-mailsjabloon (36 tekens) dat wordt gebruikt voor het versturen van een e-mail. Het ID staat in de adresbalk van het sjabloon. Als deze variabele niet wordt opgegeven, zal er geen e-mail worden verstuurd.
Variabelen in documenten
In een DiMaker-document moet ten minste één variabele voor vervanging staan, zoals %name of %city. Variabelen moeten in het Latijnse alfabet worden geschreven.
Bij het bouwen van een URL beginnen variabelen met mask_ gevolgd door de documentvariabele. Bijvoorbeeld, %name wordt mask_name.
Je kunt gegevens uit GetCourse gebruiken zoals {object.first_name} voor voornaam.
Willen bestanden per e-mail worden verzonden? Gebruik mask_email en {object.email}.
Zo kun je op basis van GetCourse-profieldata gegevens invoegen in documenten.
Tot slot, als je dynamische gegevens wilt inbrengen, zoals huidige datum, gebruik dan speciale functies.