 API

Met de API van DiMaker kunt u bestanden met persoonsgegevens genereren en, indien nodig, aan ontvangers leveren. API-verzoeken kunnen zowel vanaf een andere server als vanuit een browser via CORS worden verzonden.

Waar te beginnen

Ga naar het gedeelte «Integratie» - «API-tokens» om een beveiligd token (Secure token) voor verzoeken te verkrijgen en het gebruik ervan toe te staan. U moet ook een document aanmaken dat variabelen voor persoonsgegevens bevat, een e-mailsjabloon voor verzendingen maken, en een map in de Schijf aanmaken voor de gegenereerde bestanden.

Bestanden aanmaken

Om bestanden aan te maken, verzendt u POST-DATA, POST- of GET-verzoeken naar het adres
https://dimaker.app/api/v1/create/
met de hieronder vermelde gegevens.
Codering van verzoeken: UTF-8. Verplichte velden zijn gemarkeerd met een asterisk (*).

• secure*

  Token (string, 36 tekens).

• doc_id*

  Document-ID (string, 36 tekens) dat wordt gebruikt voor het genereren van het bestand. U kunt het ID vinden in de adresbalk bij het openen van een document. Het document mag zich niet in de prullenbak bevinden, maar kan zich in elke map in «Documenten» bevinden.

• mask*

  -string die alle te vervangen variabelen bevat in de vorm van een sleutel (variabele) - waarde (tekst om te vervangen). Hiermee kunnen gegevens voor meerdere bestanden worden opgesteld zonder limieten in aantal.
  Voorbeeld voor één bestand:
  [{"%name": "Ivanov", "%punten":"100"}]
  Voorbeeld voor meerdere bestanden:
  [{"%name": "Ivanov", "%punten":"100"}, {"%name": "Petrov", "%punten":"200"}, {"%name": "Sidorov", "%punten":"300"}]
  E-mailadressen kunnen worden opgegeven met %email. Voor de bestandsnaam gebruikt u %filename. Om bestanden naar meerdere e-mailadressen te verzenden, scheidt u deze met een komma. Hierbij wordt de verzendstatus in de Schijf weergegeven voor het eerste adres.
  Alleen dubbele aanhalingstekens mogen worden gebruikt volgens de standaard. Als de waarde van een sleutel aanhalingstekens bevat, moeten deze worden geëscaped.

  Om een afbeelding over te dragen aan een afbeeldingsblok, kunt u een directe koppeling (http:// of https://) of een in Base64 gecodeerde afbeelding gebruiken. In het laatste geval moet de string beginnen met "data:image/".

  Alternatieve methode
  Als u geen -string kunt verzenden, kunt u vervangingsstrings verzenden als velden in het verzoek. Elke te vervangen variabele moet beginnen met de prefix "mask_", bijvoorbeeld mask_name voor de variabele %name. Voor een e-mailadres gebruikt u mask_email, en voor een bestandsnaam gebruikt u mask_filename.

• mail_id

  ID van de e-mailsjabloon (string, 36 tekens) voor verzending via e-mail. Vind het ID in de adresbalk wanneer u het sjabloon opent. Als deze variabele niet is meegegeven, worden er geen e-mails verzonden.

• email_send

  Tijd voor het verzenden van de e-mail. Mogelijke waarden:
  onfinish - Alle e-mails verzenden na het aanmaken van alle bestanden (standaard).
  oncreate - E-mails direct verzenden na het genereren van elk bestand. Voor één bestand zijn onfinish en oncreate identiek.
  timeout - Verzenden na een specifieke tijdsduur:
  email_timeout_value - Numeriek interval (geheel getal).
  email_timeout_unit - Tijdseenheid: "m" (minuten), "h" (uren), "d" (dagen).
  Of gebruik een nauwkeurig tijdstip in UNIX-tijdnotatie in email_timeout_timestamp. Bij concurrentie tussen timeout en timestamp wordt voorkeur gegeven aan timestamp.

• folder_id

  ID van de map in Schijf (string, 36 tekens) voor het opslaan van bestanden. Als de map niet bestaat, wordt deze automatisch aangemaakt bij het eerste bestand.

• page_id

  Paginanummer (nummer of string) in documenten met meerdere pagina’s. U kunt één nummer doorgeven (eerste pagina is 0) of een reeks nummers (gescheiden door komma’s).

• result

  Bepaalt hoe het resultaat wordt teruggestuurd:
  

  • Geen waarde. -string met het resultaat van het verzoek (zie hieronder).
  • link. Een URL naar het gegenereerde bestand. Voor meerdere bestanden wordt de link naar het eerste bestand geretourneerd.
  • file. Het gegenereerde bestand zelf wordt geretourneerd (alleen het eerste bij meerdere bestanden).

Resultaat

De server retourneert een -string, met de volgende mogelijke waarden:

• result

  Resultaat van het verzoek:
  error - Fouten in het verzoek, geen bestanden gegenereerd.
  success - Verzoek voor bestandsaanmaak geslaagd. U kunt nu bevestigen dat bestanden succesvol zijn gemaakt of een downloadformulier tonen.

• create_id

  Generatie-ID. Alleen bij een succesvol verzoek. Kan nuttig zijn voor andere API-verzoeken.

• files

  Array met ID's van de aangemaakte bestanden. Om bestanden te downloaden in JPG bereikt u:
  https://dimaker.app/getfile/{ID}/
  Voor een PDF voegt u pdf/ toe aan het adres.

• url

  URL voor een download-widget. Het domein voor gebruik moet correct zijn ingesteld in de API-instellingen.

• error_text

  Beschrijving van fouten, zoals een onjuist Secure token of document-/folder-ID's.

Meerdere bestanden in één verzoek

Eén verzoek kan bestanden van meerdere documenten creëren (bijv. sjablonen in verschillende talen). Gebruik arrays voor doc_id[] en desgewenst andere parameters zoals folder_id[] per bestand.

Bestanden naar uzelf sturen

Een bestand wordt naar uw account-e-mailadres gestuurd. U kunt een specifieke e-mailsjabloon opgeven bij E-mailsjablonen.

Bestanden verwijderen

Om bestanden te verwijderen, verzendt u POST-DATA, POST- of GET-verzoeken naar:
https://dimaker.app/api/v1/drive/files/delete/
met de genoemde gegevens.

• secure*

  Token (string, 36 tekens).

• file_id/file_ids/creater_id

  ID's zoals gebruikelijk. Verwijderen kan naar keuze definitief of naar prullenbak (standaard).

Andere integraties