E-imza API entegrasyonu nasıl yapılır?

Satış ekibi CRM'de teklifi hazırlıyor, PDF'i indiriyor, imza platformuna giriyor, belgeyi yüklüyor, müşteriyi ekliyor ve gönderiyor. İmza gelince belgeyi indirip CRM'e geri yüklüyor. Günde otuz teklif için bu, birkaç saatlik tekrarlayan bir iştir. API entegrasyonu bu adımların hepsini sistemin kendisine yaptırır.

API entegrasyonu ne sağlar?

API, kendi yazılımınızın imza platformuyla doğrudan konuşmasını sağlar. Panelde elle yaptığınız her işi yazılımınız yapar: belgeyi yükler, alıcıları ve sırayı tanımlar, gönderir, durumu izler ve sonucu indirir. Webhook ise ters yönde çalışır: bir belge açıldığında, imzalandığında ya da reddedildiğinde platform sizin sisteminize haber verir.

Tipik kullanım alanları şunlardır:

Entegrasyon adım adım nasıl yapılır?

1. Test anahtarı alın. Canlı belgelerle çalışmadan önce test ortamında deneyin. Test anahtarıyla yapılan işlemler canlı kayıtlara karışmaz.
2. Belgeyi yükleyin. PDF'i doğrudan yükleyin ya da platformdaki bir şablondan değişkenlerle belge üretin.
3. Gönderimi oluşturun. Alıcıları, sırayı, işlem türünü (onay ya da imza), son tarihi ve doğrulama yöntemini tek istekte tanımlayın.
4. Webhook adresini kurun. Sisteminizde, platformun olay bildirimlerini alacağı bir adres açın.
5. Olayları işleyin. Gönderildi, görüntülendi, onaylandı, imzalandı, reddedildi, tamamlandı gibi olaylara göre kendi kayıtlarınızı güncelleyin.
6. Sonucu arşivleyin. Tamamlanan belgeyi ve delil paketini indirip ilgili kaydın yanına koyun.
7. Canlıya geçin. Testler bitince canlı anahtara geçin ve önce tek bir belge türüyle başlayın.

Entegrasyonda sık yapılan hatalar nelerdir?

Çift gönderim. Ağ bağlantısı istek sırasında kesildiğinde yazılım isteği yeniden gönderir. Platform ilk isteği almışsa aynı belge iki kez gider ve alıcı iki davet alır. Bunu önlemenin yolu her isteğe benzersiz bir idempotency anahtarı eklemektir; aynı anahtarla gelen ikinci istek yeni bir gönderim oluşturmaz.

Webhook imzasını doğrulamamak. Webhook adresi internete açıktır ve herkes oraya istek gönderebilir. Gelen her bildirimin imzası doğrulanmadan "imzalandı" olayı işlenirse, sahte bir istekle belge imzalanmış gibi gösterilebilir.

Webhook'a tek kaynak olarak güvenmek. Sisteminiz bir süre kapalı kalırsa bazı bildirimleri kaçırabilir. Platform teslim edilemeyen olayları yeniden dener; ama kritik süreçlerde durumu periyodik olarak sorgulamak da iyi bir yedektir.

Anahtarları koda gömmek. API anahtarı kaynak koda ya da yapılandırma dosyasına açık yazılmamalı, gizli bilgi deposunda tutulmalıdır. Her sisteme ayrı anahtar verin ki biri sızarsa yalnız onu iptal edebilesiniz.

Kişisel veri açısından nelere dikkat edilmeli?

API üzerinden alıcıların adı, telefon numarası ve e-posta adresi platforma aktarılır. KVKK'nın 12. maddesi veri sorumlusundan verilerin güvenliği için uygun teknik ve idari tedbirleri almasını ister. Entegrasyonda şunlara dikkat edin:

• Yalnız gerekli alanları gönderin; imza için gerekmeyen kişisel verileri aktarmayın.
• API anahtarlarına en az yetkiyi verin ve kullanım geçmişini izleyin.
• Webhook ile gelen verileri kendi sisteminizde de aynı saklama kurallarına bağlayın.

Konuyu elektronik onay ve imza süreçlerinde KVKK yazısında ayrıca ele aldık.

Toplu gönderimlerde API mi, panel mi?

Yılda birkaç kez yapılan toplu gönderimler için panelden Excel ile alıcı yüklemek çoğu zaman yeterlidir. Her gün tekrarlanan, bir olaya bağlı gönderimler ise API'ye uygundur. Panel yöntemini toplu belge imzalatma yazısında anlattık.

yepp API

yepp API'si REST ve JSON ile çalışır, uç noktaları /v1 altında sürümlüdür ve OpenAPI şeması yayımlanır. Gönderim oluştururken idempotency anahtarı kullanabilir, alıcıları, sırayı ve işlem türünü tek istekte tanımlayabilirsiniz. Webhook olayları HMAC ile imzalı gelir ve teslim edilemezse yeniden denenir. Panelde yapılabilen her şey API ile de yapılabilir.

Test anahtarıyla deneme yapabilirsiniz; API erişimi İşletme ve Kurumsal planlarda açıktır. Ayrıntılar için API ve webhook sayfasına bakabilirsiniz.