Geliştirici API'si · Güncellendi
İmzayı kendi ürününüzün içine koyun.
Bir PDF'ten, Word dosyasından ya da şablondan belge oluşturun, imzaya gönderin, durumunu izleyin ve imzalandığında webhook alın; hepsi kodunuzdan.
REST API
Webhook'lar
API anahtarları
eSignSimple API'si kullanımda mı?
Kendi yazılımınız artık kimsenin bir panele giriş yapmasına gerek kalmadan belge oluşturabilir, imzaya gönderebilir, durumunu izleyebilir ve imzalı kopyaları indirebilir. REST API https://esignsimple.com/api/v1 adresinde; istek ve yanıt örnekleriyle tam başvuru kaynağı geliştiriciler sayfamızda.
API üzerinden ulaşılan imzalayanlar, panelden gönderilen belgelerle tamamen aynı hesapsız imza deneyimini ve aynı kanıtları alır: bir denetim kaydı, bir tamamlanma sertifikası ve herkesin herkese açık doğrulama sayfamızda kontrol edebileceği bir SHA-256 özeti.
API nasıl çalışır?
POST /documents ile bir belge oluşturun. PDF'i ve imzalayanları ve alanları listeleyen bir JSON parçasını içeren çok parçalı (multipart) bir istek gönderirsiniz; alan konumları sayfanın kesirleri olarak verilir, böylece PDF noktaları ya da sayfa boyutlarıyla uğraşmanız gerekmez. Belge hemen gönderilir ya da send:false geçerseniz taslak olarak kalır.
Panelde zaten bir şablonunuz mu var? POST /templates/{id}/send imzalayanları doldurur ve gönderir. GET /documents belgelerinizi durum filtresiyle ve before ile imleç tabanlı sayfalamayla listeler. GET /documents/{id} durumu, imzalayanları ve tam denetim kaydını döndürür; GET /documents/{id}/download ise belge tamamlandığında imzalı PDF'i, ?file=original ile de orijinali döndürür.
Ayrıca POST /documents/{id}/void ile devam eden bir belgeyi iptal edebilir, DELETE /documents/{id} ile silebilir ve GET /me ile planınızı ve güncel kullanımınızı kontrol edebilirsiniz.
Kimlik doğrulama ve API anahtarları nasıl çalışır?
Her istek bir Bearer API anahtarı kullanır. Anahtarları Ayarlar → Geliştiriciler bölümünde oluşturur ve iptal edersiniz. Bir anahtar oluşturulduğunda yalnızca bir kez gösterilir ve biz yalnızca özetini saklarız; bu yüzden hemen gizli anahtar yöneticinize kopyalayın. Bir anahtar sızarsa iptal edip yenisini oluşturun; başka hiçbir şeyin değişmesi gerekmez.
Aynı API, yakında çıkacak mobil uygulamamızın kullanacağı Firebase ID token'larını da kabul eder. Bu bilinçli bir tercih: kendi uygulamalarımızı sizin kullandığınız aynı herkese açık API üzerine kuruyoruz, böylece her gün sınanıyor.
Hangi webhook'ları alabilirsiniz?
Sürekli sorgulamak yerine hesabınız için bir HTTPS uç noktası kaydedin; bir şey olduğunda onu bilgilendiririz. Olaylar document.completed, document.declined, document.voided ve signer.signed'dır.
Her teslimat HMAC-SHA256 ile imzalanır ve imza esign-signature başlığında gönderilir; böylece harekete geçmeden önce isteğin gerçekten bizden geldiğini doğrulayabilirsiniz. Uç noktanız başarısız olursa bir kez yeniden deneriz. Tavsiyemiz: webhook'ları bir tetikleyici olarak görün ve kesin durum için GET /documents/{id} çağırın.
İnsanlar API ile neler yapıyor?
Bir anlaşma kazanıldı olarak işaretlendiği anda sözleşme gönderen bir CRM ya da teklif aracı. Bir işe alım onaylandığında şablondan işe giriş paketi gönderen bir İK sistemi. Kira sözleşmesi gönderen ve document.completed geldiğinde imzalı PDF'i ilgili dairenin kaydına ekleyen bir gayrimenkul aracı. Birinin tablodaki satırları sözleşmelere elle kopyalamasını bitiren bir iç betik.
Haftada birkaç belge gönderiyorsanız muhtemelen API'ye hiç ihtiyacınız yok. Paneldeki şablonlar, toplu gönderim ve web formları çok daha az emekle işinizi görür.
API nasıl fiyatlandırılıyor?
Ayrı bir API planı yok. Web uygulamasındaki plan sınırları aynen geçerli: Ücretsiz plan ayda 5 belge içerir, Kişisel plan sınırsızdır (fiyatlara bakın). API ile oluşturulan belgeler, panelden gönderilen belgelerle tamamen aynı şekilde sayılır.
DocuSign, Dropbox Sign ve Adobe gibi büyük sağlayıcılar API'lerini genellikle kullanıcı planlarından ayrı, çoğu zaman yıllık zarf hacmine göre fiyatlandırır ve giriş seviyesi API planları standart aboneliklerinden belirgin biçimde pahalı olabilir. Güncel fiyatlar için sitelerine bakın.
Henüz neler yok?
Eksiklerimiz konusunda dürüstüz. Henüz gömülü imza iframe'i yok; imzalayanlar hâlâ e-postayla gönderdiğimiz bağlantı üzerinden imzalar. Resmi SDK yok; API düz HTTP ve JSON olduğu için HTTP istemcisi olan her dil çalışır. Ayrı bir sandbox ortamı yok; ücretsiz bir hesap ve kendi e-posta adreslerinizle test edin. Bunların hepsi yol haritamızda.
Neden küçük bir API ile başladık?
Bilerek dar başladık. Yaygın iş akışını iyi yapan, sınırları öngörülebilir ve satış görüşmesi gerektirmeyen küçük bir API, entegrasyonu haftalar süren devasa bir yüzeyden daha faydalıdır. İhtiyacınız olan bir şey eksikse ne geliştirdiğinizi bize anlatın; sırada neyi ekleyeceğimize gerçek entegrasyonlar karar veriyor.
Bugün hangi API uç noktaları var?
| Uç nokta | Ne yapar | Tipik kullanım |
|---|---|---|
| POST /documents | İmzalayanlar ve alanlarla bir PDF yükler, gönderir ya da taslak olarak tutar | Uygulamanızda üretilen bir sözleşmeyi göndermek |
| POST /templates/{id}/send | Bir panel şablonunu adı belli imzalayanlara gönderir | İşe alım onaylandığında işe giriş paketi |
| GET /documents ve GET /documents/{id} | Belgeleri listeler ya da durumu, imzalayanları ve denetim kaydını okur | Durumu bir CRM'e senkronize etmek |
| GET /documents/{id}/download | İmzalı PDF'i (ya da orijinali) indirir | İmzalı kopyayı bir kayda eklemek |
| POST /documents/{id}/void ve DELETE /documents/{id} | Bir belgeyi iptal eder ya da siler | Bir teklifi geri çekmek ya da taslakları temizlemek |
| GET /me | Plan ve bu ayki kullanım | Ücretsiz sınıra ulaşmadan önce uyarmak |
Sık sorulan sorular
eSignSimple'ın API'si var mı?
Evet. REST API, Bearer API anahtarları ve webhook'larla https://esignsimple.com/api/v1 adresinde kullanımda. Başvuru kaynağı geliştiriciler sayfamızda.
API ne kadar?
Ayrı bir API fiyatı yok. Normal planınız geçerlidir: Ücretsiz plan ayda 5 belge içerir, Kişisel plan sınırsızdır.
API anahtarını nasıl alırım?
Ayarlar → Geliştiriciler bölümünde oluşturun. Bir kez gösterilir ve özet olarak saklanır; bu yüzden hemen kaydedin. Anahtarları istediğiniz zaman iptal edebilirsiniz.
Hangi webhook olayları var?
document.completed, document.declined, document.voided ve signer.signed; esign-signature başlığında HMAC-SHA256 ile imzalanır ve bir kez yeniden denenir.
Gömülü imza, SDK ya da sandbox destekliyor musunuz?
Henüz değil. Üçü de yol haritamızda. Bugün imzalayanlar e-postayla gelen bir bağlantı üzerinden imzalar, siz de API'yi düz HTTP üzerinden çağırırsınız.
İlgili içerikler
Bir sonraki belgenizi bugün imzalatın.
Ayda 5 ücretsiz belgeyle başlayın. Kredi kartı gerekmez.