Functies Prijzen Documentatie Over ons Webapplicatie openen

API

Deze documentatie is automatisch vertaald met machine learning.

Met behulp van de DiMaker API kunnen bestanden worden gemaakt met persoonlijke gegevens en indien nodig worden geleverd aan ontvangers. Verzoeken naar de API kunnen zowel vanaf een andere server als via CORS-verzoeken vanuit de browser plaatsvinden.

Startgids

Om te beginnen - ga naar het gedeelte "Integratie" - "API Tokens" om een Secure token te verkrijgen voor verzoeken en sta het gebruik ervan toe. Verder moet u een document aanmaken dat variabelen voor persoonlijke gegevens bevat, evenals een sjabloon voor e-mailberichten en een map in de Schijf voor voltooide bestanden.

Bestanden aanmaken

Om bestanden te maken, moet u POST-DATA, POST-JSON of GET-verzoeken verzenden naar het adres
https://dimaker.app/api/v1/create/
met de onderstaande gegevens.
Codering van het verzoek - UTF-8. Vereiste velden zijn gemarkeerd met een asterisk.

  • secure*

    Token (tekenreeks, 36 tekens)

  • doc_id*

    ID van het document (tekenreeks, 36 tekens) dat wordt gebruikt om het bestand te maken. De ID is zichtbaar in de adresbalk wanneer het document is geopend. Het document mag niet in de prullenbak staan, maar kan in elke map van Documenten staan.

  • mask*

    JSON-tekenreeks die alle te vervangen variabelen bevat in de vorm van sleutel (variabele) - waarde (tekst voor vervanging). Kan gegevens bevatten voor het maken van meerdere bestanden (geen beperking op het aantal).
    Voorbeeld voor één bestand:
    [{"%name": "Ivanov", "%scores":"100"}]
    Voorbeeld voor meerdere bestanden:
    [{"%name": "Ivanov", "%scores":"100"}, {"%name": "Petrov", "%scores":"200"}, {"%name": "Sidorov", "%scores":"300"}]
    Voor het specificeren van e-mailadressen, gebruik %email en voor bestandsnamen %filename. Om bestanden naar meerdere e-mailadressen te sturen, moet je die gescheiden door komma's opgeven. De verzendstatus in de Schijf wordt weergegeven voor het eerste adres.
    Alleen dubbele aanhalingstekens zijn toegestaan volgens de standaard. Als de waarde van de sleutel aanhalingstekens bevat, moeten deze worden ontsnapt.

    Om een afbeelding te verzenden in een afbeeldingsblok kan je een directe link (http:// of https://) gebruiken of een in Base64 gecodeerde afbeelding. In het laatste geval moet de tekenreeks beginnen met "data:image/".

    Alternatieve methode
    Als het niet mogelijk is om een JSON-tekenreeks te verzenden, kunnen vervangingslijnen worden verzonden als verzoekvelden. Elke vervangingsvariabele moet beginnen met het voorvoegsel mask_, bijvoorbeeld mask_name met het te vervangen waarde. In het document wordt dan naar de variabele gezocht na het voorvoegsel. Bijvoorbeeld, het veld mask_name komt overeen met de variabele %name. Voor e-mailadres zoals mask_email en voor bestandsnamen zoals mask_filename.

  • mail_id

    ID van het e-mailsjabloon (tekenreeks, 36 tekens) dat wordt gebruikt bij e-mail verzenden. De ID is zichtbaar in de adresbalk wanneer het sjabloon open is. Als de variabele niet is opgegeven, wordt de e-mail niet verzonden.

  • email_send

    De tijd wanneer de e-mail met het bestand moet worden verzonden. Kan de volgende waarden aannemen:
    onfinish - verzend alle e-mails na het maken van alle bestanden (standaard)
    oncreate - verzend e-mails onmiddellijk nadat het bestand is gemaakt. Bij het maken van één bestand zijn onfinish en oncreate identiek.
    timeout - e-mails versturen na een tijdsinterval. In dat geval moeten twee extra parameters worden opgegeven:
    email_timeout_value - numerieke waarde van het interval na welk e-mails worden verstuurd, geheel getal
    email_timeout_unit - eenheid van tijdsinterval. Kan de waarden aannemen "m" (minuten), "h" (uren), "d" (dagen).
    Of, om een specifieke verzendtijd aan te geven, geef de tijd als unix time in email_timeout_timestamp. Als zowel email_timeout_value als email_timeout_timestamp zijn opgegeven, heeft de laatste prioriteit.

  • folder_id

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

  • storage_period

    De bewaartijd van de bestanden in Schijf. Als deze parameter niet is opgegeven, blijven de bestanden onbeperkt bewaard totdat ze handmatig worden verwijderd. Om na een tijdsinterval te verwijderen, stel deze waarde in op:
    timeout. In dat geval moeten nog twee parameters worden opgegeven:
       storage_period_timeout_value - numerieke waarde van het tijdsinterval waarna bestanden worden verwijderd, geheel getal
       storage_period_timeout_unit - eenheid van het tijdsinterval. Kan de waarden "m" (minuten), "h" (uren), "d" (dagen) aannemen.
    Of, om een exacte verwijdertijd aan te geven, geef de tijd op in het unix time-formaat in storage_period_timeout_timestamp. Als zowel storage_period_timeout_value als storage_period_timeout_timestamp zijn opgegeven, heeft de laatste prioriteit.

  • page_id

    Het bladsnummer (nummer of tekenreeks) als het document meerdere bladen bevat. U kunt één nummer (het eerste blad is nummer 0) of meerdere nummers (gescheiden door komma's) van de bladen opgeven die u wilt gebruiken voor het maken van het bestand.

  • result

    Bepaalt in welk formaat het resultaat wordt geretourneerd. Kan de volgende waarden aannemen:

    • Geen waarde. Er wordt een JSON-tekenreeks geretourneerd met het resultaat van het verzoek (zie hieronder)
    • link. Bij een succesvol verzoek wordt er een tekenreeks geretourneerd die een link naar het aangemaakte bestand bevat (als er meerdere bestanden werden gemaakt, naar het eerste bestand). Om het daadwerkelijke bestand te verkrijgen, moet het worden opgevraagd via de opgegeven link. De voorbereiding van de bestanden duurt 1 tot 5 seconden per bestand. Voordat het bestand wordt aangemaakt, geeft een verzoek naar dit adres een 404-fout. Als het verzoek niet tot de aanmaak van een bestand leidt, wordt er een JSON-tekenreeks met een fout geretourneerd (zie hieronder).
    • file. Bij een succesvol verzoek wordt het voltooide bestand zelf geretourneerd (als er meerdere bestanden werden aangemaakt, alleen het eerste bestand). Aangezien het maken van een bestand 1 tot 5 seconden duurt, zal de retour plaatsvinden zodra het bestand is aangemaakt. Bij een groot aantal verzoeken aan de API kan de tijd voor het maken van het bestand toenemen. Als het bestand niet wordt voorbereid binnen 30 seconden, retourneert de API een 404-fout (hoewel het verzoek voor de aanmaak van het bestand uiteindelijk wordt uitgevoerd). Als het verzoek niet leidt tot aanmaak van een bestand, wordt een JSON-tekenreeks met een fout geretourneerd (zie hieronder). Als verwacht wordt dat er meer dan één verzoek per 5 seconden naar de API zal zijn, gebruik dan deze parameter niet.

Resultaat

Het resultaat is een JSON-tekenreeks die de volgende mogelijke waarden kan aannemen:

  • result

    Resultaat van het verzoek. Kan de volgende waarden aannemen:
    error - fout in het verzoek. Bestanden niet aangemaakt.
    success - succesvol verzoek voor de aanmaak van bestanden. Afhankelijk van het gebruiksscenario van de API, kunt u het succesvolle maken van bestanden melden of een formulier geven om bestanden te downloaden.

  • create_id

    ID van de creatie. Alleen indien succesvol verzoek. Dit kan handig zijn voor andere API-verzoeken.

  • files

    Array met de ID's van de aangemaakte bestanden. Alleen indien succesvol verzoek. Om het daadwerkelijke bestand in JPG-formaat te verkrijgen, moet u zich naar https://dimaker.app/getfile/{ID}/ richten. Voor PDF-bestanden kan je de adresregel aanvullen met pdf/. De API retourneert de ID van het bestand onmiddellijk, maar de voorbereiding van de bestanden duurt 1 tot 5 seconden per bestand. Voordat het bestand wordt aangemaakt, geeft een verzoek naar https://dimaker.app/getfile/{ID}/ een 404-fout.

  • url

    URL-tekenreeks voor de download-widget van bestanden. Alleen bij succesvol verzoek. Er moet een Iframe worden gemaakt met de opgegeven URL. Alleen navigeren naar de URL zal geen resultaat geven. De domeinnaam van de website waarop de bestandsoverdracht plaatsvindt, moet correct zijn ingesteld in de API-instellingen.
    Voor het downloaden van elk bestand zou er ongeveer 1 seconde + een paar seconden voor de verwerking van de gehele groep nodig zijn. Onmiddellijk na het verzenden van het verzoek kunt u de Iframe met de opgegeven URL openen. Als de aanmaak van bestanden nog niet is voltooid, wordt er een overeenkomstig bericht weergegeven. Zodra de bestanden klaar zijn, wordt dezelfde Iframe aangeboden om te downloaden.
    U kunt de download-widget weergeven in een dialoogvenster bovenop de pagina. Hiervoor moet u een Iframe maken met de volgende aanvullende stijlen: position:fixed; width:100%; height:100%; top:0; bottom:0; right:0; left:0; z-index:10000; background: rgb(0 0 0 / 72%); Voeg "?view=modal" toe aan de adresregel en neem deze Iframe op in body.

  • error_text

    Alleen indien fout. Tekstuele beschrijving van de fout. Mogelijke fouten zijn: incorrect Secure token, mask voor vervanging, document ID, e-mailsjabloon ID, map ID in Drive, of interne serverfout.

Voorbeeld van geretourneerde gegevens bij een succesvol verzoek:
{
"result":"success",
"create_id":"b4caf05b-6757-4d9c-b4bc-1924a9b31796",
"url":"https://embed.dimaker.app/widgets/get/927ebf68-2f55-4b20-a18c-c1171ee113db/b4caf05b-6757-4d9c-b4bc-1924a9b31796/",
"files":[
"369dc61e-40c2-46c0-81f4-e31ca8c33cc2",
"d94c6efb-0076-438b-bb84-fead9c1ae556",
"716e1081-c8ee-442b-b0b0-0681b2ed5d90"
]
}

Meerdere bestanden aanmaken in één verzoek

Het is mogelijk om in één verzoek meerdere bestanden van verschillende documenten aan te vragen. Met een dergelijk verzoek kunt u bijvoorbeeld meerdere bestanden aanmaken met sjablonen in de Russische en Engelse taal. Het verzenden van één aanvraag zal het server naar behoefte bestanden laten aanmaken.

Om een dergelijke aanvraag te verzenden, moet de variabele doc_id een array zijn (variable naam - doc_id[]). In dit geval kunnen er meerdere doc_id[] variabelen in één aanvraag zijn om meerdere bestanden te maken. Andere variabelen zoals mail_id, email_send, folder_id kunnen ook als arrays worden verzonden zodat elk bestand wordt verzonden met een specifieke sjabloon, op een bepaald tijdstip of naar een specifieke map. Als dit niet vereist is, moet alleen het veld doc_id een array zijn.

Bijvoorbeeld, als u twee bestanden van verschillende documenten moet aanmaken en die in verschillende mappen in Schijf wilt plaatsen. Daarvoor moet u twee doc_id[] variabelen en twee folder_id[] variabelen (in dezelfde volgorde) versturen. Bovendien, als de eis is om ze in één e-mail te verzenden, moet één mail_id worden gespecificeerd en in email_send[] eerst 'manual' en daarna 'oncreate' worden vermeld. In dit geval het eerste bestand wordt aangemaakt, daarna de tweede, waarna ze samen met het in mail_id gespecificeerde bericht worden verzonden.

Stuur het bestand naar uzelf nadat het is aangemaakt

Het bestand wordt naar de e-mail van het account gestuurd zodra het is aangemaakt. In het veld "E-mailsjabloon" kunt u selecteren welke sjabloon u wilt gebruiken voor de verzending. U kunt van te voren een aparte e-mailsjabloon maken voor verzending naar het account in E-mailsjablonen. Als in de tekst van de e-mail de variabele %data wordt gebruikt, dan worden alle gegevens van het bestand op die plaats toegevoegd in de vorm van een tabel.

Bestanden verwijderen

Om bestanden te verwijderen, moet u POST-DATA, POST-JSON of GET-verzoeken versturen naar het adres
https://dimaker.app/api/v1/drive/files/delete/
met de hieronder opgetekende gegevens. De codering van het verzoek moet UTF-8 zijn. Verplicht velden zijn gemarkeerd met een asterisk.

  • secure*

    Token (tekenreeks, 36 tekens)

  • file_id

    ID van het bestand (tekenreeks, 36 tekens) dat zal worden verwijderd. De bestand-ID wordt teruggegeven in het files array bij aanmaak via de API. Het bestand mag niet zich in de prullenbak bevinden.

    OF

  • file_ids

    Array van bestand-ID's (tekenreeks, 36 tekens) die zullen worden verwijderd als het verwijderen van meerdere bestanden in één aanvraag is benodigd.

    OF

  • creater_id

    Creatie-ID (tekenreeks, 36 tekens) als het bestand via de API is aangemaakt. Creatie-ID kan in plaats van file_id of file_ids worden doorgegeven. In dat geval worden alle bestanden met deze creatie-ID verwijderd. De creatie-ID wordt teruggegeven in het veld create_id bij aanmaak van bestanden via de API.

    delete_forever

    Of het bestand definitief moet worden verwijderd zonder naar de prullenbak te verplaatsen. Standaard wordt het bestand naar de prullenbak verplaatst. Het kan de volgende waarden aannemen:

    • 0 - verplaats naar prullenbak (standaard)
    • 1 - definitief verwijderen

    Bestanden uit de prullenbak worden automatisch 60 dagen na verplaatsing verwijderd.

Voorbeeld

Voorbeeld van een correct verzoek voor het verwijderen van bestanden:
{
"secure":"b4caf05b-6757-4d9c-b4bc-1924a9b31796",
"file_id":"369dc61e-40c2-46c0-81f4-e31ca8c33cc2"
}

Resultaat

Als resultaat zal de server een JSON-tekenreeks retourneren die de volgende mogelijke waarden kan aannemen:

  • result

    Resultaat van het verzoek. Kan de volgende waarden aannemen:
    error - fout in het verzoek. Bestanden niet verwijderd.
    success - succesvol verzoek voor het verwijderen van bestanden.

  • files

    Array met de ID's van de verwijderde bestanden. Alleen indien succesvol verzoek.

  • error_text

    Alleen bij fout. Tekstuele omschrijving van de fout. Mogelijke fouten zijn: incorrect Secure token, bestand-ID, creatie-ID of interne serverfout.

Voorbeeld van geretourneerde gegevens bij een succesvol verzoek:
{
"result":"success",
"files":["369dc61e-40c2-46c0-81f4-e31ca8c33cc2"]
}

Andere integraties

Integratie met Google SheetsAanmaakformulierIntegratie via APIIntegratie met GetCourseIntegratie met TypeForm

Klaar om te starten?

Openen Webapplicatie openen