API
Korystając z API DiMaker, można generować pliki z danymi osobowymi i dostarczać je odbiorcom, jeśli to konieczne. Żądania do API mogą być wysyłane zarówno z innego serwera, jak i z przeglądarki przy użyciu CORS.
Jak zacząć
W sekcji „Integracje” - „Tokeny API” musisz uzyskać token Secure na potrzeby żądań oraz umożliwić korzystanie z tego tokenu. Dodatkowo należy utworzyć dokument zawierający zmienne na dane osobowe, a także szablon wiadomości e-mail do wysyłki oraz folder na Dysku na gotowe pliki.
Tworzenie plików
Aby utworzyć pliki, należy wysłać żądania POST-DATA, POST- lub GET na adres
https://dimaker.app/api/v1/create/
z poniższymi danymi.
Kodowanie zapytania - UTF-8. Pola wymagane oznaczone są gwiazdką.
-
secure*
Token (ciąg znaków, 36 znaków)
-
doc_id*
ID dokumentu (ciąg znaków, 36 znaków), który będzie wykorzystany do utworzenia pliku. ID można znaleźć w pasku adresu, gdy dokument jest otwarty. Dokument nie powinien znajdować się w koszu, ale może być umieszczony w dowolnym folderze Dokumentów.
-
mask*
-string zawierający wszystkie zmienne do zamiany w formacie klucz (zmienna) - wartość (tekst do zamiany). Może zawierać dane do utworzenia wielu plików (bez ograniczeń ilości).
Przykład dla jednego pliku:
[{"%name": "Ivanow", "%punkty":"100"}]
Przykład dla kilku plików:
[{"%name": "Ivanow", "%punkty":"100"}, {"%name": "Petrow", "%punkty":"200"}, {"%name": "Sidorow", "%punkty":"300"}]
Aby wskazać adres e-mail, należy użyć zmiennej %email, a dla nazwy pliku %filename. Jeśli pliki mają być wysłane na kilka adresów e-mail, należy je podać oddzielone przecinkami. Status wysyłki w systemie Dysku będzie wyświetlany dla pierwszego adresata.
Należy używać tylko podwójnych cudzysłowów zgodnie ze standardem. Jeśli wartość klucza zawiera cudzysłowy, muszą być one maskowane.Dla zamieszczenia obrazu w polu z grafiką, można podać bezpośredni link (http:// lub https://) albo zakodowany obraz w formacie Base64. W przypadku Base64 ciąg powinien zaczynać się od "data:image/".
Metoda alternatywna
Jeżeli nie można przesłać ciągu , dane do zamiany można przesłać jako pola zapytania. Każda zmienna powinna zaczynać się od prefiksu mask_, np. mask_name, i zawierać wartość do zamiany. W dokumencie zmienna odpowiadająca polu będzie wyszukiwana po prefiksie. Np. mask_name będzie odpowiadało zmiennej %name. Aby wskazać adres e-mail, należy użyć mask_email, a dla nazwy pliku - mask_filename. -
mail_id
ID szablonu wiadomości (ciąg znaków, 36 znaków) służącego do wysyłki e-mail. ID znajdziesz w pasku adresu, gdy edytujesz szablon. Jeśli zmienna nie zostanie przekazana, wiadomość nie zostanie wysłana.
-
email_send
Czas wysyłki wiadomości z plikiem. Możliwe wartości:
--- + napisz koniec w любой момент
onfinish - Wyślij wszystkie wiadomości po utworzeniu wszystkich plików (domyślnie).
oncreate - Wyślij wiadomość natychmiast po stworzeniu pliku. W przypadku tworzenia jednego pliku onfinish i oncreate są identyczne.
timeout - Wyślij wiadomości po określonym czasie. W tym przypadku należy podać jeszcze dwa parametry:
email_timeout_value - wartość numeryczna interwału czasu w minutach, godzinach lub dniach (jednostka m/h/d - 'm' na minuty, 'h' - godziny, 'd' - dni )..Inne integracje