 API

Med DiMaker API kan du snabbt skapa filer med personliga uppgifter och vid behov skicka dem till mottagarna. API-förfrågningar kan skickas både från en extern server och direkt från webbläsaren via CORS.

Kom igång

Gå till avsnittet «Integration» - «API-token» för att generera en säker token att använda för förfrågningar och aktivera användningen av denna token. Dessutom behöver du skapa ett dokument med variabler för personliga uppgifter, en e-postmallsutkast för utskick, samt en mapp på Disk där de färdiga filerna sparas.

Skapa filer

För att skapa filer skicka POST-DATA, POST- eller GET-förfrågningar till adressen
https://dimaker.app/api/v1/create/
tillsammans med de nödvändiga uppgifterna nedan.
Teckenkodning för förfrågningar: UTF-8. Obligatoriska fält är markerade med en stjärna.

• secure*

  Token (sträng, 36 tecken)

• doc_id*

  Dokument-ID (sträng, 36 tecken) som används för att skapa filen. ID:n kan hittas i adressfältet när dokumentet är öppet. Dokumentet får inte finnas i papperskorgen men kan vara placerat i vilken mapp som helst i Dokument.

• mask*

  -sträng som innehåller alla variabler för ersättning i form av nyckel (variabel) - värde (ersättningstext). Kan även inkludera data för flera filer utan begränsningar av mängd.
  Exempel för en fil:
  [{"%name": "Ivanov", "%poäng":"100"}]
  Exempel för flera filer:
  [{"%name": "Ivanov", "%poäng":"100"}, {"%name": "Petrov", "%poäng":"200"}, {"%name": "Sidorov", "%poäng":"300"}]
  För att ange en e-postadress använd %email, för filnamn %filename. Vid utskick av filer till flera e-postadresser separera med komma, men skicka endast status till den första adressen.
  Använd endast dubbla citattecken enligt standarden. Om nyckelvärden innehåller citattecken måste dessa vara escaperade.

  För att bädda in bilder i block kan du använda direktlänkar (http:// eller https://) eller Base64-kodade bilder. I det senare fallet måste strängen börja med "data:image/".

  Alternativ metod
  Om -strängar inte kan skickas kan variabler också skickas som enkla fält i förfrågan genom att använda prefixet mask_. Exempelvis, mask_name motsvarar %name i dokumentet. För e-post använd mask_email och för filnamn mask_filename.

• mail_id

  E-postmallens ID (sträng, 36 tecken) som används för utskick via e-post. Om variabeln utelämnas skickas inget e-postmeddelande.

• email_send

  Tidpunkt för e-postutskick med filen. Kan ta följande värden:
  onfinish - Alla meddelanden skickas efter att samtliga filer skapats (standardvärde)
  oncreate - Skickar meddelanden direkt efter att varje fil skapats. Om en enda fil skapas är onfinish och oncreate desamma.
  timeout - Skickar meddelanden efter en viss tidsintervall. I detta fall måste ytterligare två parametrar anges:
  email_timeout_value - heltalsvärde för tiden att vänta innan meddelandet skickas
  email_timeout_unit - tidsenhet för intervallet. Kan vara "m" (minuter), "h" (timmar), eller "d" (dagar).
  Alternativt kan du specificera exakt tid genom att skicka Unix-tid i email_timeout_timestamp. Om både timeout och timestamp skickas prioriteras timestamp.

• folder_id

  Mapp-ID för Disk (sträng, 36 tecken) där filerna ska sparas. Om mappen inte finns skapas den automatiskt vid skapandet av den första filen.

• page_id

  Sidnummer (nummer eller sträng) om dokumentet innehåller flera sidor. Kan ange en enskild sida (första sidan är 0) eller flera sidor, separerade med komma, som ska användas för att skapa filen.

• result

  Anger i vilket format resultatet ska returneras. Kan ta följande värden:

  • Inget värde. En -sträng med resultatet av förfrågan returneras (se nedan)
  • link. Om förfrågan lyckas returneras en länk till den skapade filen (för flera filer returneras länken till den första). Att ladda ner filen kan ta mellan 1 och 5 sekunder. Tills dess returnerar förfrågan ett 404-fel. Om förfrågan misslyckas returneras en -sträng med felmeddelande.
  • file. Om förfrågan lyckas returneras själva filen (för flera filer returneras endast den första). Eftersom genereringen av filer tar 1-5 sekunder kommer ett svar bara returneras när filen är redo. Om många API-förfrågningar görs kan tiden öka. Misslyckade förfrågningar returnerar en -sträng med felmeddelande. Om förväntat antal förfrågningar överstiger 1 per 5 sekunder, bör inte detta format användas.

Resultat

Servern returnerar en -sträng med följande möjliga värden:

• result

  Förfrågans resultat. Kan ta följande värden:
  error - Förfrågan misslyckades. Inga filer skapades.
  success - Förfrågan lyckades och filerna skapades.

• create_id

  Genererings-ID returneras vid lyckad förfrågan. Kan användas för följande API-förfrågningar.

• files

  Array som innehåller ID:n för de skapade filerna vid lyckad förfrågan. För att hämta JPEG-använd https://dimaker.app/getfile/{ID}/. För PDF lägg till pdf/. Observera att det tar 1-5 sekunder per fil att skapa och att oavklarade förfrågningar ger 404-fel.

• url

  URL-sträng för en widget som möjliggör filhämtning. Gäller endast vid lyckade förfrågningar. Skapa en iframe med denna URL, direkt navigering fungerar ej. Domänen för nedladdning måste vara korrekt inställd i API-inställningarna. Widgeten kan laddas för nedladdning när filerna är färdiga.

• error_text

  Endast vid fel. Felbeskrivning: ogiltig säker token, mask för ersättning, dokument-ID, e-postmallens ID, mapp-ID eller serverinternt fel.

---

Andra integrationer