 API

DiMaker API’yi kullanarak kişisel verileri içeren dosyalar oluşturabilir ve gerekirse bunları alıcılara ulaştırabilirsiniz. API çağrıları hem başka bir sunucudan hem de CORS özellikli tarayıcılardan yapılabilir.

Başlangıç

“Entegrasyon” → “API Tokenları” bölümünden güvenli bir token alıp bu tokenin kullanılmasına izin vermelisiniz. Ayrıca, kişisel veri değişkenlerini içeren bir belge, e-posta gönderimleri için bir şablon e-posta ve hazır dosyalar için bir Disk klasörü oluşturmanız gerekiyor.

Dosya Oluşturma

Dosya oluşturmak için aşağıdaki adrese POST-DATA, POST- veya GET çağrıları gönderilmelidir:
https://dimaker.app/api/v1/create/
Çağrı verilerinin tarifi aşağıda açıklanmıştır. Karakter kodlaması UTF-8’dir. Zorunlu alanlar yıldız (*) işareti ile belirtilmiştir.

• secure*

  Token (36 karakterlik bir dize)

• doc_id*

  Belgenin ID’si (36 karakterlik bir dize), dosya oluşturmak için kullanılacaktır. Belge açıkken adres çubuğunda bu ID'yi bulabilirsiniz. Belge çöp kutusunda olmamalıdır, ancak Belgeler klasöründeki herhangi bir yerde bulunabilir.

• mask*

  Değişim için kullanılacak tüm değişkenleri anahtar (değişken) - değer (metin) olarak içeren formatlı bir dize. Birden fazla dosya oluştururken kullanılabilir (sayı sınırlaması yok).
  Tek bir dosya için örnek:
  [{"%name": "İvanov", "%puan":"100"}]
  Birden fazla dosya örneği:
  [{"%name": "İvanov", "%puan":"100"}, {"%name": "Petrov", "%puan":"200"}, {"%name": "Sidorov", "%puan":"300"}]
  E-posta adresini belirtmek için %email, dosya adını belirtmek için %filename kullanmalısınız. Birden fazla e-posta adresine dosyalar göndermek için adresleri virgülle ayırabilirsiniz. Bu durumda, Disk üzerindeki gönderim durumu yalnızca ilk adres için gösterilecektir.
  Standarta uygun olarak yalnızca çift tırnak kullanılabilir. Eğer değer içinde çift tırnak kullanılıyorsa, bunlar kaçış karakteri ile belirtilmelidir.

  Görüntü bloğuna bir resim göndermek için URL (http:// veya https://) kullanılabilir ya da resim Base64 olarak kodlanabilir. Base64 kullanımında dize "data:image/" ile başlamalıdır.

  Alternatif Yöntem
  Eğer formatlı dize kullanımı mümkün değilse, değişim değerleri çağrı parametreleri olarak gönderilebilir. Değiştirilecek her değişken, mask_ ön eki ile başlamalıdır (örneğin, mask_name) ve değişim değerini içermelidir. Bu durumda belgede değişkenin adı, ön ek olmadan aranır. Örneğin, mask_name parametresi %name değişkenine karşılık gelir. E-posta adresi için mask_email, dosya adı için mask_filename kullanılabilir.

• mail_id

  Gönderim için kullanılacak e-posta şablonunun ID’si (36 karakterlik bir dize). Şablonu açtığınızda adres çubuğunda bu ID'yi bulabilirsiniz. Değer belirtilmezse, e-posta gönderilmeyecektir.

• email_send

  Dosya ile e-posta gönderim zamanı. Şu değerleri alabilir:
  onfinish - Tüm dosyalar oluşturulduktan sonra e-postaları gönder (varsayılan).
  oncreate - Dosya oluşturulduktan hemen sonra e-postaları gönder. Tek bir dosya oluşturuluyorsa, onfinish ve oncreate aynıdır.
  timeout - E-postaları bir süre sonra gönder. Bu durumda iki ek parametre belirtilmelidir:
  email_timeout_value - süre, tam sayı olarak belirtilir
  email_timeout_unit - süre birimi. Değerleri şunlar olabilir: "m" (dakika), "h" (saat), "d" (gün).
  Alternatif olarak, e-posta gönderim zamanı Unix zaman damgası formatında email_timeout_timestamp ile belirtilebilir. Eğer timeout ve email_timeout_timestamp birlikte belirtilirse, sonuncusu önceliklidir.

• folder_id

  Dosyaların kaydedileceği Disk klasörünün ID’si (36 karakterlik bir dize). Klasör yoksa, ilk dosya oluşturulduğunda otomatik olarak oluşturulur.

• page_id

  Dokümandaki sayfaların (tek bir sayfa veya birden fazla) sırasını belirtir. Tek bir sayfa numarası (örneğin, 0) veya liste (virgülle ayrılmış) şeklinde belirtilebilir.

• result

  Sonucun hangi formatta döndürüleceğini belirler. Şu değerleri alabilir:
  Değer yok: formatta sonuç döner (aşağıda açıklanmıştır).
  link: Başarılı bir çağrıdan sonra oluşturulan dosyaya link döner. İlk dosyanın linkini almak için tekrar çağrıda bulunulabilir. Ancak dosyayı hazırlamak 1-5 saniye sürebilir. Dosya hazır değilse, çağrı 404 hatası döner.

Sonuç

Sunucudan dönecek , aşağıdaki değerleri içerebilir:

• result

  Çağrının sonucudur. Şu değerleri alabilir:
  error: Hata. Dosyalar oluşturulamadı.
  success: Dosyalar başarıyla oluşturuldu. API kullanımına bağlı olarak başarı mesajı veya dosya alımı için bir form gösterilebilir.

• create_id

  Başarılı bir çağrıda dönüş yapar. Bu ID, diğer çağrıların takibi için kullanılabilir.

Diğer Entegrasyonlar