POST /v1/envelopes

{
  "template": "tpl_mutual_nda",
  "variables": {
    "client": { "name": "Acme Robotics" }
  },
  "recipients": [
    { "role": "client", "name": "Jane Doe",
      "email": "jane@acme.dev" }
  ],
  "delivery": "embedded"
}

201 env_8Gm2kQ4rT1 · sent → completed · sealed

Sözleşme girer, imzalı çıkar.

Bona Fide, API olarak sunulan e-imzadır. Bir şablonu ve verilerinizi imzaya hazır bir zarfa dönüştürün, kişilerin ürününüzün içinde veya barındırılan bir sayfada imzalamasını sağlayın ve herkesin doğrulayabileceği mühürlü bir PDF alın.

Hızlı başlangıç API referansı

Parçalar nasıl bir araya gelir

Şablonlar

Bir PDF (veya Word dosyası) yükleyip alanları yerleştirin ya da sözleşmeyi Belge modunda yazın. Değişkenler bir JSON Schema’dır; böylece API, herhangi bir şey gönderilmeden önce verilerinizi doğrular. Sürümler yayımlandıktan sonra değiştirilemez.

Zarflar

Tek bir POST /v1/envelopes çağrısı, şablonu değişkenlerinizle oluşturur ve alıcılara rol ve sıraya göre yönlendirmeyi başlatır. Deneme çalıştırmaları, idempotency anahtarları ve externalId ile tekilleştirme yerleşik olarak gelir.

İmzalama, sizin yönteminizle

E-posta bağlantıları, barındırılan bir sayfa veya kendi uygulamanızın içinde <bf-signing> web bileşeni (React ve Vue sarmalayıcılarıyla); kısa ömürlü, tek kullanımlık oturumları arka ucunuz oluşturur.

Herkesin kontrol edebileceği kanıt

Tamamlanan her belge, herkese açık bir zaman damgası otoritesinden PAdES belge zaman damgası alır ve parmak izi, köklerini Bona Fide’ın Ed25519 ile imzaladığı bir Merkle ağacına eklenir. Herkes bir kopyayı hesap gerekmeden doğrulayabilir.

Tek bakışta yaşam döngüsü

Panelde veya API üzerinden bir şablon tasarlayın, ardından bir sürüm yayımlayın.
Bir zarf gönderin: şablon kimliği, değişkenleriniz ve her rol için bir alıcıyla POST /v1/envelopes.
İmzalayın: alıcılar bir e-posta bağlantısı alır veya siz bir imzalama oturumu oluşturup yerleştirirsiniz (delivery: "embedded").
Tamamlayın: son alıcı imzaladığında, girilen her değeri içeren bir envelope.completed webhook’u alırsınız.
Mühürleyin: mühürlü PDF (tamamlama sertifikasıyla birlikte), envelope.sealed geldiğinde hazırdır.
Doğrulayın: herkes PDF’i doğrulama sayfasına bırakabilir veya herkese açık doğrulama API’sini çağırabilir.

API’yi keyifli kılan şeyler

Üzerine işlem yapabileceğiniz hatalar. Her hata RFC 9457 problem+json biçimindedir; doğrulama hataları her sorun için /variables/client/email gibi bir JSON Pointer içerir.
Güvenli yeniden denemeler. POST isteklerinde bir Idempotency-Key gönderin; yeniden deneme ilk yanıtı tekrar oynatır.
Ücretsiz, sınırsız test modu. bf_test_ anahtarları, hiçbir zaman ücretlendirilmeyen filigranlı zarflar oluşturur. Bkz. Kimlik doğrulama.
Bir standarda uyan webhook’lar. Teslimatlar Standard Webhooks uyarınca imzalanır, üç gün boyunca yeniden denenir ve tekrar oynatılabilir.
Koddan üretilen OpenAPI 3.1. Referans ile indirilebilir openapi.json / openapi.yaml dosyaları, API’nin doğrulamada kullandığı zod sözleşmelerinden üretilir.

Sonraki adımlar

Hızlı başlangıçOn dakikada API anahtarı, şablondan zarf, imzalama ve tamamlanma webhook'u.

KavramlarŞablonlar, roller, alanlar, zarflar, alıcılar, oturumlar ve kuruluşlar.

Yerleşik imzalamaİmzalama deneyimini ile ürününüzün içine yerleştirin.

DoğrulamaMühürleme ve sabitleme nasıl çalışır, bir belgeyi kendiniz nasıl kontrol edersiniz.

API https://api.bonafidesign.com adresindedir. Bu dokümantasyondaki tüm yollar bu adrese görelidir.