Kullanıcı Kılavuzu İptal

Adobe Acrobat Sign API - SSS

 İçindekiler

Adobe Acrobat Sign Kılavuzu

Yenilikler

  1. Ön Sürüm Notları
  2. Sürüm Notları
  3. Önemli Bildirimler

Başlayın

  1. Yöneticiler için hızlı başlangıç kılavuzu
  2. Kullanıcılar için hızlı başlangıç kılavuzu
  3. Geliştiriciler için
  4. Video eğitim kitaplığı
  5. SSS

Yönetim

  1. Admin Console'a Genel Bakış
  2. Kullanıcı Yönetimi
    1. Kullanıcı ekleme
      1. Kullanıcı Ekleme
      2. Kullanıcıları Toplu Olarak Ekleme
      3. Dizinden Kullanıcı Ekleme
      4. MS Azure Active Directory'den Kullanıcı Ekleme
    2. Fonksiyon odaklı kullanıcılar oluşturma
      1. Teknik hesaplar - API odaklı
      2. Hizmet hesapları - Manuel olarak yönlendirilen
    3. Sağlama hataları olan kullanıcıları kontrol etme
    4. Ad/E-posta Adresi Değiştirme
    5. Kullanıcının grup üyeliğini düzenleme
    6. Bir kullanıcının grup üyeliğini grup arayüzü üzerinden düzenleme
    7. Bir kullanıcıyı yönetici rolüne yükseltme
    8. Kullanıcı Kimlik Türleri ve SSO
    9. Kullanıcı Kimliğini Değiştirme
    10. Kullanıcıların Kimliğini MS Azure ile Doğrulama
    11. Kullanıcıların Kimliğini Google Federation ile Doğrulama
    12. Ürün Profilleri
    13. Oturum Açma Deneyimi
  3. Hesap/Grup Ayarları
    1. Ayarlara Genel Bakış
    2. Global Ayarlar
      1. Hesap düzeyi ve kimliği
      2. Yeni Alıcı Deneyimi
      3. Kendi Kendine İmzalı İş Akışları
      4. Toplu Halde Gönder
      5. Web Formları
      6. Özel Gönderme İş Akışları
      7. Power Automate İş Akışları
      8. Kitaplık Belgeleri
      9. Sözleşmelerle form verileri toplama
      10. Sınırlı Belge Görünürlüğü
      11. İmzalanan sözleşmenin PDF kopyasını ekleme
      12. E-postaya bağlantı ekleme
      13. E-postaya görüntü ekleme
      14. E-postalara eklenen dosyalar şu şekilde adlandırılır:
      15. Belgelere denetim raporu ekleme
      16. Birden çok belgeyi tek bir belgede birleştirme
      17. Belgeleri ayrı ayrı indirme
      18. İmzalanan belgeyi yükleme
      19. Hesabımdaki kullanıcılar için delegasyon
      20. Harici alıcıların delege etmesine izin verme
      21. İmzalama yetkisi
      22. Gönderme yetkisi
      23. Elektronik Mühür ekleme yetkisi
      24. Varsayılan saat dilimini ayarlama
      25. Varsayılan tarih formatını ayarlama
      26. Birden Çok Gruptaki Kullanıcılar (UMG)
        1. UMG kullanmak için yükseltme
      27. Grup Yöneticisi İzinleri
      28. Alıcıyı değiştirme
      29. Denetim Raporu
        1. Genel bakış
        2. İşlem doğrulama sayfasında kimliği doğrulanmamış erişime izin verme
        3. Hatırlatıcı ekleme
        4. Görüntüleme olaylarını ekleme
        5. Sözleşme sayfası/ek sayısı ekleme
      30. Ürün İçi Mesajlar ve Rehberlik
      31. Erişilebilir PDF'ler
      32. Yeni içerik oluşturma deneyimi
      33. Sağlık müşterisi
    3. Hesap Ayarları
      1. Logo ekleme
      2. Şirket Ana Bilgisayar Adını/URL'sini özelleştirme
      3. Şirket adı ekleme
      4. Sözleşme sonrası URL yönlendirmesi
    4. İmza Tercihleri
      1. İyi biçimlendirilmiş imzalar
      2. Alıcıların imza eklemesine izin verme
      3. İmzalayanlar adlarını değiştirebilir
      4. Alıcıların kayıtlı imzalarını kullanmasına izin verme
      5. Özel Kullanım Koşulları ve Tüketici Açıklaması
      6. Alıcıları form alanlarında gezindirme
      7. İmzalamayı reddetme
      8. Zaman Dalgaları iş akışlarına izin verme
      9. İmzalayanlardan Unvanlarını veya Şirketlerini sağlamalarını isteme
      10. İmzalayanların ıslak imza yazdırmasına ve yerleştirmesine izin verme
      11. E-imzalama sırasında mesajları gösterme
      12. İmzalayanlardan imzalarını oluştururken mobil cihaz kullanmalarını isteme
      13. İmzalayanlardan IP adresi isteme
      14. Katılım damgasında şirket adını ve unvanı hariç tutma
    5. Dijital İmzalar
      1. Genel bakış
      2. İndirme ve Acrobat ile İmzalama
      3. Bulut İmzaları ile İmzalama
      4. Kimlik Sağlayıcıları için meta verileri ekleme
      5. Sınırlı Bulut İmza Sağlayıcıları
    6. Elektronik Mühürler
    7. Dijital Kimlik
      1. Dijital Kimlik Ağ Geçidi
      2. Kimlik Kontrolü politikası
    8. Rapor Ayarları
      1. Yeni rapor deneyimi
      2. Klasik rapor ayarları
    9. Güvenlik Ayarları
      1. Tekli Oturum Açma ayarları
      2. Beni Hatırla ayarları
      3. Oturum açma parola politikası
      4. Oturum açma parolası kuvveti
      5. Web oturumu süresi
      6. PDF şifreleme türü
      7. API
      8. Kullanıcı ve grup bilgileri erişimi
      9. İzin Verilen IP Aralıkları
      10. Hesap Paylaşımı
      11. Hesap paylaşım izinleri
      12. Sözleşme paylaşma denetimleri
      13. İmzalayan kimliği doğrulama
      14. Sözleşme imzalama parolası
      15. Belge parolası güvenlik düzeyi
      16. Coğrafi konuma göre imzalayanları engelleme
      17. Telefonla Kimlik Doğrulama
      18. Bilgi Tabanlı Kimlik Doğrulama (KBA)
      19. Sayfa çıkarmaya izin verme
      20. Belge bağlantısı kullanım süresi
      21. Web kancaları/geri çağırmalar için istemci sertifikası yükleme
      22. Zaman damgası
    10. Gönderim ayarları
      1. Oturum açtıktan sonra Gönder sayfasını gösterme
      2. Gönderimde alıcı adını zorunlu kılma
      3. Bilinen kullanıcılar için ad değerlerini kilitleme
      4. İzin verilen alıcı rolleri
      5. E-şahitlere izin verme
      6. Alıcı grupları
      7. Gerekli alanlar
      8. Belge ekleme
      9. Alan düzleştirme
      10. Sözleşmelerde Değişiklik Yapma
      11. Sözleşme adı
      12. Diller
      13. Özel mesajlar
      14. İzin verilen imza türleri
      15. Hatırlatıcılar
      16. İmzalanan belge parola koruması
      17. Sözleşme Bildirimi'ni gönderme yolları
      18. İmzalayan tanımlama seçenekleri
        1. Genel bakış
        2. İmzalama parolası
        3. E-posta ile Tek Kullanımlık Parola
        4. Acrobat Sign kimlik doğrulaması
        5. Telefonla kimlik doğrulama
        6. Bulut tabanlı dijital imza
        7. Bilgiye dayalı kimlik doğrulama
        8. Resmi Kimlik
        9. İmzalayan Kimliği raporları
      19. İçerik Koruması
      20. Noter işlemlerini etkinleştirme
      21. Belge Sona Erme Tarihi
      22. İmzaları önizleme, yerleştirme ve alan ekleme
      23. İmzalama sırası
      24. Liquid mode
      25. Özel iş akışı kontrolleri
      26. E-imza sayfası için yükleme seçenekleri
      27. İmza sonrası onay URL'sini yeniden yönlendirme
    11. Mesaj Şablonları
    12. Bio-Pharma Ayarları
      1. Genel bakış
      2. Kimlik doğrulamayı uygulama
      3. İmzalama nedenleri
    13. İş Akışı Entegrasyonu
    14. Noter Onayı Ayarları
    15. Ödeme Entegrasyonu
    16. İmzalayan Mesajları
    17. SAML Ayarları
      1. SAML Yapılandırması
      2. Microsoft Active Directory Federation Service'i yükleme
      3. Okta'yı yükleme
      4. OneLogin'i yükleme
      5. Oracle Identity Federation'ı yükleme
    18. Veri Yönetimi
    19. Zaman Damgası Ayarları
    20. Harici Arşiv
    21. Hesap Dilleri
    22. E-posta Ayarları
      1. E-posta üstbilgi/altbilgi görüntüleri
      2. Bireysel kullanıcı e-posta altbilgisine izin verme
      3. İmza Gerekli e-postasını özelleştirme
      4. Kime ve Bilgi alanlarını kişiselleştirme
      5. Bağlantısız Bildirimleri Etkinleştir
      6. E-posta şablonlarını özelleştirme
    23. echosign.com'dan adobesign.com'a geçiş
    24. Alıcılar için Seçenekleri Yapılandırma
  4. Yasal gereklilikler kılavuzu
    1. Erişilebilirlik
      1. Erişilebilirlik Uyumluluğu
      2. Acrobat masaüstü ile erişilebilir formlar oluşturma
      3. Erişilebilir AcroForms oluşturma
    2. HIPAA
    3. GDPR
      1. GDPR'ye Genel Bakış
      2. Kullanıcıyı redakte etme
      3. Kullanıcının sözleşmelerini redakte etme
    4. 21 CFR bölüm 11 ve EudraLex Ek 11
      1. 21 CRF bölüm 11 doğrulama paketi
      2. 21 CFR ve EudraLex Ek 11 el kitabı
      3. Paylaşılan sorumluluklar analizi
    5. Sağlık müşterileri
    6. IVES desteği
    7. Sözleşmeleri "Kasaya Alma"
    8. AB/İngiltere ile ilgili hususlar
      1. AB/İngiltere Sınır ötesi işlemleri ve eIDAS
      2. Elektronik olarak imzalanan senetler için HMLR gereksinimleri
      3. Brexit'in Birleşik Krallık'taki e-imza yasalarına etkisi
  5. Sözleşmeleri Toplu Halde İndirme
  6. Etki alanı talep etme
  7. Kötüye Kullanım Bildirme bağlantıları

Sözleşmeleri Gönderme, İmzalama ve Yönetme

  1. Alıcı Seçenekleri
    1. E-posta hatırlatıcısını iptal etme
    2. E-imza sayfasındaki seçenekler
      1. E-imza sayfasına genel bakış
      2. Sözleşmeyi alan olmadan okumak için açma
      3. Sözleşme imzalamayı reddetme
      4. İmzalama yetkisi delege etme
      5. Sözleşmeyi yeniden başlatma
      6. Sözleşmenin PDF'sini indirme
      7. Sözleşme geçmişini görüntüleme
      8. Sözleşme mesajlarını görüntüleme
      9. Elektronik imzayı yazılı imzaya dönüştürme
      10. Yazılı imzadan elektronik imzaya dönüştürme 
      11. Form alanları arasında gezinme
      12. Form alanlarından verileri temizleme
      13. E-imza sayfasını büyütme ve sayfada gezinme
      14. Sözleşme araçlarında ve bilgilerinde kullanılan dili değiştirme
      15. Yasal Uyarıları inceleme
      16. Acrobat Sign Çerez Tercihlerini Ayarlama
  2. Sözleşme Gönderme
    1. Gönder sayfasına genel bakış
    2. Yalnızca kendinize bir sözleşme gönderme
    3. Diğer kullanıcılara sözleşme gönderme
    4. Islak İmzalar
    5. Alıcı imzalama sırası
    6. Toplu Halde Gönder
      1. Toplu Halde Gönder özelliğine genel bakış
      2. Toplu Halde Gönderme - Üst şablon yapılandırma
      3. Toplu Halde Gönderme - CSV dosyasını yapılandırma
      4. Toplu Halde Gönder işlemini iptal etme
      5. Toplu Halde Gönder hatırlatıcıları ekleme
      6. Toplu Halde Gönder için raporlama
  3. Belgelerde alan oluşturma
    1. Uygulama içi içerik oluşturma ortamı
      1. Otomatik alanı algılama
      2. İçerik oluşturma ortamını kullanarak alanları sürükleyip bırakma
      3. Form alanlarını alıcılara atama
      4. Önceden Doldurma rolü
      5. Alanları yeniden kullanılabilir alan şablonuyla uygulama
      6. Alanları yeni bir kitaplık şablonuna taşıma
      7. Sözleşme gönderme işlemleri için güncellenmiş içerik oluşturma ortamı
    2. Metin etiketli formlar oluşturma
    3. Acrobat ile formlar oluşturma (AcroForms)
      1. AcroForm oluşturma
      2. Erişilebilir PDF oluşturma
    4. Alanlar
      1. Alan türleri
        1. Yaygın alan türleri
        2. Satır İçi Görüntüler
        3. Damga Görüntüleri
      2. Alan içeriği görünümü
      3. Alan doğrulamaları
      4. Maskelenmiş alan değerleri
      5. Göster/gizle koşullarını ayarlama
      6. Hesaplanan alanlar
    5. İçerik Oluşturma Hakkında SSS
  4. Sözleşmeleri İmzalama
    1. Size gönderilen sözleşmeleri imzalama
    2. Doldur ve İmzala
    3. Kendi kendine imzalama
  5. Sözleşmeleri Yönetme
    1. Yönet sayfasına genel bakış
    2. Sözleşmeleri delege etme
    3. Alıcıları Değiştirme
    4. Belge Görünürlüğünü Sınırlama
    5. Sözleşmeyi İptal Etme
    6. Yeni hatırlatıcılar oluşturma
    7. Hatırlatıcıları inceleme
    8. Hatırlatıcıyı iptal etme
    9. Power Automate akışlarına erişme
    10. Daha Fazla Eylem...
      1. Arama nasıl çalışır?
      2. Sözleşmeyi görüntüleme
      3. Sözleşmeden şablon oluşturma
      4. Sözleşmeleri görünümden gizleme/gösterme
      5. İmzalanan sözleşmeyi yükleme
      6. Gönderilmiş bir sözleşmenin dosyalarını veya alanlarını değiştirme
      7. Alıcının kimlik doğrulama yöntemini düzenleme
      8. Sona erme tarihi ekleme veya değiştirme
      9. Sözleşmeye not ekleme
      10. Tekil sözleşme paylaşma
      11. Sözleşmenin paylaşımını kaldırma
      12. Bireysel sözleşme indirme
      13. Sözleşmenin dosyalarını ayrı ayrı indirme
      14. Sözleşmenin Denetim Raporunu indirme
      15. Sözleşmenin alan içeriğini indirme
  6. Denetim Raporu
  7. Rapor ve Veri dışa aktarımları
    1. Genel bakış
    2. Raporlara kullanıcı erişimi verme
    3. Rapor çizelgeleri
      1. Yeni bir rapor oluşturma
      2. Sözleşme Raporları
      3. İşlem Raporları
      4. Ayarlar Etkinlik Raporu
      5. Raporları düzenleme
    4. Veri Dışa Aktarımları
      1. Yeni bir veri dışa aktarımı oluşturma
      2. Veri dışa aktarımlarını düzenleme
      3. Dışa aktarılan veri içeriklerini yenileme
      4. Veri dışa aktarımlarını indirme
    5. Raporları/dışa aktarımları yeniden adlandırma
    6. Raporları/dışa aktarımları yineleme
    7. Rapor/dışa aktarım planlama
    8. Raporları/dışa aktarımları silme
    9. İşlem Kullanımını kontrol etme

Gelişmiş Sözleşme Özellikleri ve İş Akışları

  1. Web formları
    1. Web formu oluşturma
    2. Web formunu düzenleme
    3. Web formunu Devre Dışı Bırakma/Etkinleştirme
    4. Web formunu Gizleme/Gösterme
    5. URL veya komut dosyası kodu bulma
    6. Web formu alanlarını URL parametreleriyle önceden doldurma
    7. Daha sonra tamamlamak için web formu kaydetme
    8. Web formlarını yeniden boyutlandırma
  2. Yeniden Kullanılabilir Şablonlar (Şablon kitaplıkları)
    1. Acrobat Sign kitaplığındaki ABD resmi formları
    2. Kitaplık şablonu oluşturma
    3. Kitaplık şablonunun adını değiştirme
    4. Kitaplık şablonunun türünü değiştirme
    5. Kitaplık şablonunun izin düzeyini değiştirme
    6. Paylaşılan şablonları kopyalama, düzenleme ve kaydetme
    7. Kitaplık şablonları için toplu alan verilerini indirme
  3. Web formlarının ve kitaplık şablonlarının sahipliğini aktarma
  4. Power Automate İş Akışları
    1. Power Automate entegrasyonuna ve içerdiği yetkilere genel bakış
    2. Power Automate entegrasyonunu etkinleştirme
    3. Yönet sayfasındaki Bağlam İçi Eylemler
    4. Power Automate kullanımını takip etme
    5. Yeni akış oluşturma (Örnekler)
    6. Akışlarda kullanılan tetikleyiciler
    7. Acrobat Sign dışındaki akışları içe aktarma
    8. Akışları yönetme
    9. Akışları düzenleme
    10. Akışları paylaşma
    11. Akışları devre dışı bırakma veya etkinleştirme
    12. Akışları silme
    13. Faydalı Şablonlar
      1. Yalnızca yönetici
        1. Tamamlanan tüm belgeleri SharePoint'e kaydetme
        2. Tamamlanan tüm belgeleri OneDrive for Business'a kaydetme
        3. Tamamlanan tüm belgeleri Google Drive'a kaydetme
        4. Tamamlanan tüm belgeleri DropBox'a kaydetme
        5. Tamamlanan tüm belgeleri Box'a kaydetme
      2. Sözleşmeleri arşivleme
        1. Tamamlanan belgelerinizi SharePoint'e kaydetme
        2. Tamamlanan belgelerinizi One Drive for Business'a kaydetme
        3. Tamamlanan belgelerinizi Google Drive'a kaydetme
        4. Tamamlanan belgeleri DropBox'a kaydetme
        5. Tamamlanan belgelerinizi Box'a kaydetme
      3. Web formu sözleşmelerini arşivleme
        1. Tamamlanan web formu belgelerini SharePoint Kitaplığına kaydetme
        2. Tamamlanan web formu belgelerini OneDrive for Business'a kaydetme
        3. Tamamlanan belgeleri Google Drive'a kaydetme
        4. Tamamlanan web formu belgelerini Box'a kaydetme
      4. Sözleşme verilerini ayıklama
        1. İmzalanan belgelerden form alanı verilerini ayıklama ve Excel sayfasını güncelleme
      5. Sözleşme bildirimleri
        1. Sözleşme içeriği ve imzalanan sözleşmeyle birlikte özel e-posta bildirimleri gönderme
        2. Adobe Acrobat Sign bildirimlerinizi Teams kanalında alma
        3. Adobe Acrobat Sign bildirimlerini Slack'e alma
        4. Adobe Acrobat Sign bildirimlerini Webex'e alma
      6. Sözleşme oluşturma
        1. Power App formundan ve Word şablonundan belge oluşturma ve imzaya gönderme
        2. OneDrive'da Word şablonundan sözleşme oluşturma ve imza alma
        3. Seçilen Excel satırı için sözleşme oluşturma, incelemeye ve imzaya gönderme
  5. Özel Gönderme iş akışları
    1. Özel Gönderme İş Akışlarına Genel Bakış
    2. Yeni Gönderme İş Akışı oluşturma
    3. Gönderme İş Akışını Düzenleme
    4. Gönderme İş Akışlarını Etkinleştirme veya Devre Dışı Bırakma
    5. Gönderme İş Akışlarıyla sözleşme gönderme
  6. Kullanıcıları ve sözleşmeleri paylaşma
    1. Kullanıcı paylaşma
    2. Sözleşme paylaşma

Diğer ürünlerle entegrasyon

  1.  Acrobat Sign entegrasyonlarına genel bakış
  2. Salesforce için Acrobat Sign
  3. Microsoft için Acrobat Sign
    1. Microsoft 365 için Acrobat Sign
    2. Outlook için Acrobat Sign
    3. Word/PowerPoint için Acrobat Sign
    4. Teams için Acrobat Sign
    5. Microsoft PowerApps ve Power Automate için Acrobat Sign
    6. Microsoft Arama İşlevi için Acrobat Sign Bağlayıcı
    7. Microsoft Dynamics için Acrobat Sign
    8. Microsoft SharePoint için Acrobat Sign
  4. Diğer Entegrasyonlar
    1. ServiceNow için Acrobat Sign
    2. HR ServiceNow için Acrobat Sign
    3. SAP SuccessFactors için Acrobat Sign
    4. Workday için Acrobat Sign
    5. NetSuite için Acrobat Sign
    6. VeevaVault için Acrobat Sign
    7. Coupa BSM Suite için Acrobat Sign
  5. İş ortağı tarafından yönetilen entegrasyonlar
  6. Entegrasyon anahtarı alma

Acrobat Sign Developer

  1. REST API'leri
    1. Yöntem belgeleri
    2. SDK/Geliştirici Kılavuzu
    3. API hakkında SSS
  2. Web Kancaları
    1. Web kancalarına genel bakış
    2. Yeni web kancası yapılandırma
    3. Web kancasını görüntüleme veya düzenleme
    4. Web kancalarını devre dışı bırakma veya yeniden etkinleştirme
    5. Web kancasını silme
    6. İki yönlü SSL sertifikaları
    7. API'deki web kancaları

Destek ve Sorun Giderme

  1. Müşteri Desteği Kaynakları
  2. İşletme Müşterileri Başarı Kaynakları

API erişimi yalnızca işletme ve geliştirici seviyesindeki hesaplar için ayrılmıştır.

Temel belgelerin bağlantıları

Not:

Eski SOAP API'leri, Mayıs 2021'den itibaren desteklenmemektedir.

SOAP API kullanan tüm müşteriler hesaplarını en kısa zamanda REST API'ye taşımalıdır.

Oturum açtıktan sonra Hesap > Acrobat Sign API > API Bilgileri > REST API'leri ve Belgeleri
bölümüne gidin.


Genel Kavramlar

Sayfayı Web Kullanıcı Arabiriminde görüntüleyerek veya sürükleyip bırakarak ya da API aracılığıyla transientDocumentId kullanıp imzalayan rolü atayarak belge oluşturamazsınız.

transientDocuments çağrısı, 7 gün boyunca geçerli olan transientDocumentID'yi geri döndürür.  Bunu, yalnızca daha sonraki API çağrıları için kullanabilirsiniz. API sunucusunda saklanır ve bu kimliğe atanır. Bir dosya yükleyin ve sonraki API çağrılarında bu dosyanın kimliğini referans alın.

REST API'yi kullanarak bir belgeyi doğrudan Sözleşmeye yükleyemezsiniz.

REST gereklilikleri uyarınca, önce bir geçici belge oluşturun ve ardından bu kimliği Sözleşme, Widget veya Kitaplık yöntemlerinde dosya kaynağı olarak kullanın.

Geçici belge; PDF, doc, docx gibi Adobe sunucularına yüklenen bir raw kaynak dosyasıdır. Dolayısıyla, temel belgenizi API sunucularına ve web üzerinde geçici bir belgeye aktarmanın kolay bir yoludur.

Evet, API çağrısı POST /agreements üzerinden v6'daki iş akışlarını kullanarak sözleşme yayınlayabilirsiniz. API çağrısında workflowId parametresini aktarın.

GET /workflows çağrısını kullanarak bir iş akışının workflowId'sini alabilirsiniz.

  1. Adobe Sign'da yönetici olarak oturum açın

  2. Hesap > Adobe Sign API > API İsteği Günlüğü konumuna gidin

    API Günlükleri

  1.  Adobe Sign Hesabında yönetici olarak oturum açın

  2. Hesap > Adobe Sign API > API Bilgileri konumuna gidin

  3. REST API Örnekleri bağlantısını tıklatın.

    Not:

    JavaScript SDK'yı indirmek için https://github.com/adobe-sign/AdobeSignJsSdk adresine bakın.

v6'dan itibaren "sendThroughWeb" seçeneği kullanılamaz. state bu seçeneğin yerine geçer. Bu, sözleşmenin yer aldığı durumdur. Durum alanı yalnızca POST çağrılarında sağlanabilir. GET /agreements/{ID} çağrısında geri döndürülmez ve PUT /agreements/{ID} çağrısında sağlanırsa göz ardı edilir. Sözleşmenin nihai durumu GET /agreements/ID çağrısından alınabilir.

state(string) = ["AUTHORING" (İÇERİK OLUŞTURMA) veya "DRAFT" (TASLAK) ya da "IN_PROCESS" (İMZA SÜRECİNDE)].

AUTHORING (İÇERİK OLUŞTURMA), kullanıcının sözleşmeyi göndermeden önce belgelerde içerik oluşturmasına olanak tanır. Burada içerik oluşturma işlemi, sözleşme belgelerinde form alanlarını yapılandırmalarıyla (atanan kişi, koşullar, veri türü vb.) birlikte oluşturma, düzenleme veya yerleştirme anlamına gelir. Belge, Authoring (İçerik Oluşturma) durumunda yayınlandıktan sonra Adobe Sign Yönet sekmesinin Taslak bölümünde görünür.

DRAFT (TASLAK), nihai kaynağı oluşturmak için adımlar halinde güncellenebilen ve Adobe Sign Yönet sekmesinin Taslak bölümünde görünmeyen, amaçlanan nihai kaynağın geçici veya ilk aşamasıdır. Draft (Taslak) durumu kullanıldığında Katılımcı kümesi bilgileri gerekli değildir ve taslağı tamamlamak için PUT /agreements/agreementId ayarlanırken bunlar daha sonra atanabilir. Bu adım, sözleşmeyi oluşturmak için gereken tüm verilere ulaşana kadar birkaç kez tekrarlanabilir.

IN_PROCESS (İMZA_SÜRECİNDE), sözleşme durumunu İmzaya Gönderildi olarak değiştirir ve Adobe Sign Yönet sekmesinin İmzaya Gönderildi bölümünde görünür.

sendThroughWeb, sözleşmeyi etkileşimli olarak göndermenizi sağlar. v5 POST /agreements isteklerinin "seçenekler" alanındaki çeşitli parametreler, kullanıcının bu etkileşimli görünümü (Gönder sayfası) yapılandırmasına olanak tanır. fileUploadOptions gibi tüm bu sayfa yapılandırma parametreleri POST agreements/ID/views api'ye taşınmıştır.

Dolayısıyla, AUTHORING (İÇERİK OLUŞTURMA) durumunda POST /agreements API üzerinden bir sözleşme oluşturarak sendThroughWeb'e ulaşabilirsiniz. Ardından, dilediğiniz yapılandırmada bir sonraki sayfanın URL'sini istemek için POST agreements/ID/views API çağrısı yapabilirsiniz.

Aşağıdaki adımları uygulayın:

1. REST API V6 belgelerine gidin ve POST/agreements yöntemini seçin.
2. Aşağıdaki talep kodunu kullanın:

{

  "fileInfos": [

    {

      "transientDocumentId": "***************************"

    }

  ],

  "name": "test",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@gmail.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

3. Now, use the method post /agreements/{agreementId}/views with below request code:

 

{

  "name": "AUTHORING"

}

Yanıt kodu, içerik oluşturma alanları URL'sini sağlar.

Geri çağırma URL'si aşağıdaki şekillerde tanımlanabilir:

  • Gerektiğinde geri çağırma URL'sini tanımlamak için aşağıdaki parametreyi kullanın:

    "callbackInfo": "",
  • Hesabın tamamı için varsayılan geri çağırma URL'sini ayarlamak üzere Adobe Sign destek ekibiyle iletişime geçin.

SOAP UI (SmartBear), API çağrısı yaptığınızda aldığınız şekilde, aşağıdakine benzer SSL bağlantı hatası alır. Bu hata genellikle eski SSL'yi veya TLS1.2'den daha eski bir TLS protokolü kullanıyorsanız ortaya çıkar

ERROR: Exception in request: javax.net.ssl.SSLException: Received fatal alert: protocol_version (HATA: Talepte istisna: javax.net.ssl.SSLException: Kritik uyarı alındı: protocol_version)
ERROR: An error occurred [Received fatal alert: protocol_version], see error log for details (HATA: Bir hata oluştu [Kritik uyarı alındı: protocol_version], ayrıntılar için hata günlüğüne bakın)

  1. Bin klasörünün altındaki VMOPTIONS dosyasına (-Dsoapui.https.protocols=SSLv3,TLSv1.2) ekleyin.

  2. C:\Program Files\SmartBear\SoapUI-5.2.1\bin konumuna gidin (SOAP UI'ı yüklediğiniz yere bağlıdır. C:\Program Dosyaları (x86) altında olabilir)

  3. VMOPTIONS dosyasında, tam dosya okuma/yazma iznini etkinleştirin.

    VMOPTIONS

  4. VMOPTIONS dosyasını sağ tıklatıp Özellikler>Güvenlik sekmesi>Kullanıcı Seç>Düzenle'yi tıklatın. (Düzenle düğmesinin üzerinde Kullanıcı Erişim Denetimi simgesi görünür)>Tüm onay kutularını işaretleyin ve Tamam'ı tıklatın.

  5. Aynı işlemi Yöneticiler, Sistemler ve tüm uygulama paketleri için de tekrarlayın.

  6. Not Defteri'ni kullanarak dosyayı açın.

  7. En alta "-Dsoapui.https.protocols=SSLv3,TLSv1.2" protokolünü ekleyin ve değişiklikleri kaydedin.

  8. SOAP UI'ı kapatın ve yeniden başlatın. API çağrısı yaptığınızda SSL hatası olmadan çalışır. (Kontrol etmek için test ping çağrısı yapın).

Aşağıda Adobe Sign uygulamasında İstemci Kimliği ve İstemci Parolası oluşturma adımları verilmiştir:

  1. Adobe Sign hesabında oturum açın.

  2. Hesap > Adobe Sign API > API Uygulamaları konumuna gidin.

    Fnord.

  3. Bir uygulama oluşturmak için + simgesini tıklatın.

    Fnord.

  4. Adı ve Görüntüleme Adını girin.

  5. Etki Alanı altında, MÜŞTERİ öğesini seçin ve Kaydet'i tıklatın.

    Fnord.

  6. Tek tıklatmayla uygulamayı vurgulayın.

  7. Uygulama için OAuth'u Yapılandır öğesini tıklatın.

    Fnord.

  8. Yönlendirme URI'sını girin.

  9. Gerekli kapsamları etkinleştirmek için ilgili onay kutularını işaretleyin ve Kaydet'i tıklatın.

  1. Adobe Sign'da hesap yöneticisi olarak oturum açın

  2. Hesap > Adobe Sign API > API Bilgileri konumuna gidin

  3. Entegrasyon Anahtarı bağlantısını tıklatın

    Entegrasyon Anahtarı'na gidin

    Not:

    Entegrasyon Anahtarı bağlantısını görmüyorsanız hesabınızı etkinleştirmesi için Başarı yöneticiniz ile iletişime geçin.

    • Anahtarı sezgisel bir değerle Adlandırın
    • Uygulama işleviniz için gereken çeşitli Kapsamları seçin
    • Anahtar tamamen yapılandırıldığında Kaydet'i tıklatın
    Entegrasyon Anahtarı Oluşturma arabirimi

  4. Anahtar kaydedildikten sonra şurada bulunabilir: Hesap > Kişisel Tercihler > Erişim Belirteçleri

    Anahtarın adı ve etkinleştirilmiş tüm kapsamlar listelenir.  

    Eylem bağlantılarını görüntülemek için anahtar açıklamasını bir kez tıklatın:

    • Entegrasyon Anahtarı: Bu bağlantı gerçek anahtarı sağlar
    • İptal Et: Bu işlem, erişim belirtecini iptal eder ve kalıcı olarak siler
    Erişim Belirteçleri - Entegrasyon Anahtarı

  1. Adobe Sign hesabında oturum açın.

  2. Hesap > Adobe Sign API > API Uygulamaları konumuna gidin.

  3. Bir uygulama oluşturmak için + simgesini tıklatın.

    Postman1

  4. Uygulama için OAuth'u Yapılandır öğesini tıklatın.

    Fnord.

  5. Aşağıdaki bağlantıyı kullanarak Yetkilendirme Kodu oluşturun. İstemci Kimliği, Yönlendirme URI'sı ve kapsamları, uygulamada seçilen aşağıdaki URL ile aynı olmalıdır (aşağıdaki URL'de boşluk bırakmaktan kaçının ve "NA1" benzeri parçalar Adobe Sign hesabının ait olduğu konumdaki gibidir):

    https://secure.na1.echosign.com/public/oauth?redirect_uri=https://www.google.co.in&response_type=code&client_id=CBJCHBCAABAAo9FZgq31_5BVG_kcIXEe6gNtn-R-gdNe&scope=user_login:self+agreement_send:account

  6. Çağrı başarılı olursa Adres çubuğundan Yetkilendirme kodunu seçin.

    Fnord.

  7. Postman'ı https://www.getpostman.com/apps bağlantısından indirip yükleyin.

  8. İndirilip yüklendikten sonra, GÖNDERİ oluşturmak için YENİ seçeneğini tıklatın.

  9. Adobe Sign hesabınızın ait olduğu konuma uygun şekilde https://secure.na1.echosign.com/oauth/token bağlantısını girin.

  10. Üstbilgiler altında, Content-Type seçeneğini application/x-www-form-urlencoded olarak girin.

  11. Gövde altında x-www-form-urlencoded öğesinin seçili olduğundan emin olun. Aşağıdaki parametreleri Adobe Sign hesabında oluşturulan uygulamadaki ilgili değerlerle birlikte girin ve GÖNDER'i tıklatın.

    Fnord.

  12. Tüm bilgiler doğruysa bu işlem yanıttaki erişim belirtecini ve yenileme belirtecini geri döndürür:

    Fnord.

OAuth işlemi sırasında aşağıdaki noktaları takip ettiğinizden emin olun:

1. Doğru İstemci Kimliği ve Yönlendirme URI'sı belirtilmelidir.
2. Yetkilendirme URL'sinde sağlanan kapsamlar, Adobe Sign uygulamasında sağlanan kapsamlarla tam olarak eşleşmelidir.
3. Yapılandırılan hesaba uygun şekilde doğru parça (na1, na2, au1, e1, jp1) kullanılmalıdır.
4. Yetkilendirme URL'sinde sağlanan tüm alanlar (varsa) kaldırılmalıdır.
5. Yetkilendirme URL'si söz dizimi kontrol edilmelidir:

https://secure.na1.echosign.com/public/oauth?redirect_uri=https://secure.na1.echosign.com/public/oauthDemo&
response_type=code&client_id=9MEJXY4Y4R7L2T&scope=agreement_send

Erişim belirteçleri yalnızca 3600 saniye (bir saat) süreyle geçerlidir ve bu sürenin ardından kullanılamaz.

API talep tutucu, gerektiğinde yeni Erişim belirteçleri oluşturmak için Yenile belirteçlerini kullanabilir.

Web kancaları REST API v6 ve sonraki sürümlerde desteklenir.

Bir Web kancası alıcısı 72 saat içinde yanıt vermezse web kancası devre dışı bırakılır ve bildirim gönderilmez.

Web kancası için hedef URL herhangi bir nedenle kapanırsa Adobe Sign, JSON'yi sıraya alır ve 72 saat boyunca aşamalı bir döngüde yeniden gerçekleştirmeyi dener.

Teslim edilmeyen olaylar tekrar deneme kuyruğunda kalır ve sonraki 72 saat içinde bildirimler mümkün olduğunca gerçekleştikleri sırayla teslim edilmeye çalışılır.

Bildirimleri yeniden teslim etmeye çalışmak için denemeler arasındaki sürenin sürekli olarak iki katına çıkarıldığı bir strateji uygulanır. Denemelere 1 dakikalık aralıklarla başlanır, daha sonra bu aralık 12 saatte bir yükselir ve böylece 72 saat içinde 15 kez yeniden deneme yapılmış olur.

 

Doğrudan Adobe Sign kullanıcı arabiriminden web kancası oluşturmak için öncelikle aşağıdaki adımları kullanarak Azure AD Function Apps üzerinden web kancası URL'si oluşturun:

  1. Microsoft hesabıyla şurada oturum açın: https://portal.azure.com/.

  2. AzureAD hesabı altında Function Apps'e kaydolun.

    Azure Menüsü

  3. AzureAD adresine gidin ve Function Apps > İşlevler için + simgesini tıklatın.

  4. Dil olarak Webhook+API Javascript'i seçin ve İşlev Oluştur seçeneğini tıklatın.

    Azure API Kullanıcı Arabirimi

  5. Index.js dosyasını aşağıdaki kod parçacığıyla değiştirin:

    module.exports = function (context, req) { 
        var clientId = req.headers['x-adobesign-clientid']; 
        // Validate that the incoming ClientID is genuine 
        if (clientId === '************************************') { 
            context.res = { 
                // status: 200, /* Defaults to 200 */ // any 2XX response is acceptable 
                body: { 
                    'xAdobeSignClientId' : clientId, 
                     
                }, 
                headers : { 
                    'Content-Type' : 'application/json' 
                } 
            }; 
        } 
        else { 
            context.res = { 
                status: 400, 
                body: "Opps!! Illegitimate Call identified" 
            }; 
        } 
        context.done(); 
    };
  6. Sağ köşedeki Test düğmesini tıklatın ve aşağıdaki üstbilgiyi girin:

    X-AdobeSign-ClientId as ***********************

    API Testi

  7. Kaydet ve Çalıştır'ı tıklatın.

  8. Aşağıdaki üstbilgiyle 200 OK yanıtı aldıktan sonra, İşlev URL'sini Al'ı tıklatın

    200 yanıt

  9. URL'yi kopyalayın ve Adobe Sign Kullanıcı Arabirimi'ne giderek Web kancaları oluşturmak için + simgesini tıklatın.

  10. Aşağıdaki bilgiyi girin:

    • Ad: Diğer yöneticilerin kolayca anlayabileceği sezgisel bir ad önerilir.
    • Kapsam: Web kancasının yakalayacağı ağ genişliğini belirtin. Hesap ve Grup, arabirimde mevcuttur.
      API; Hesap, Grup, Kullanıcı ve Kaynak kapsamlarını destekler.
    • Her web kancası için yalnızca bir Kapsam tanımlanabilir
    • URL: Adobe Sign'ın JSON yükünü ilettiği hedef URL.
    • Olaylar: Adobe Sign'ın JSON oluşturma ve URL'ye iletme işlemini tetikleyen durumlar.
      Her olay, tetikleyici olayla ilgili farklı bir yük oluşturur
      Bir web kancasında Birden Çok Olay yer alabilir.
    • Bildirim Parametreleri: Bildirim Parametreleri, Olay JSON yükü bölümlerini tanımlar ve sadece önemli olan Olay bölümlerini seçmenize olanak tanır.
    Web Kancası Kullanıcı Arabirimi

  11. Web kancası tam olarak tanımlandıktan sonra Kaydet'i tıklatın; yeni web kancası tetiklenen olaylara anında yanıt vermeye başlar.

Sözleşme varlığı, sözleşme oluşturabileceğiniz kitaplık belgesi, widget ve sözleşmenin kendisi gibi varlıkları ifade eder.

Sözleşme Varlığı Olaylarını aramak için öncelikle ilgili arama parametreleri ile agreementAssetEvents'i oluşturan API'ye bir talep oluşturun.

Yanıt, arama kimliği parametresi ve sonraki sayfa imleciyle birlikte sonuçların ilk sayfasıdır. Varsa daha fazla sayfa sonuç getirmek için API ile bunu kullanabilirsiniz. Bu API, arama kimliğine göre agreementAssetEvents'i getirir.

  1. 5. Sürüm için REST API Belgelerini açın.

  2. post/search/agreementAssetEvents'e gidin ve ilgili kapsamlarla erişim belirtecini oluşturun.

  3. Talep kodunda, gerekliliğe göre başlangıç ve bitiş tarihini tanımlayın:

    { 
      "endDate": "2018-05-22T22:33:33", 
      "startDate": "2017-12-22T22:33:33" 
    }
  4. Deneyin'i tıklatın. Sözleşme kimliği olarak da kullanılabilen sözleşme varlığı kimliklerini getirir.


Kullanıcı/Hesap Yönetimi

  1. Adobe Sign'da oturum açın.
  2. Hesap>Adobe Sign API >REST API belgeleri konumuna gidin.
  3. 5. Sürümü seçin.
  4. Post /users yöntemi altında,
    UserCreationInfo yöntemi altında bahsedilen talep kodunu kullanın
    {
    "email": "email@email.com",
    "firstName": "AA",
    "lastName": "AB",
    "password":"12******rte"
    }

Kullanıcı yetkilerini yönetmek için Admin Console'u (Adobe One) kullanan Adobe Sign hesapları, kullanıcı oluşturmak veya mevcut kullanıcıları yönetmek için Adobe Sign API'yi kullanamaz.

Adobe One Admin Console, Adobe Sign API'den farklı bir API kullanır. Daha fazla bilgi için şu makalelere bakın:

 

Grup Kimliği Alma:

  1. https://secure.na1.echosign.com/public/docs/restapi/v5 adresine gidin.

  2. Kaynaklar ve İşlemler öğesinin altında, gruplar öğesini tıklatın.

  3. GET /groups'u tıklatın.

  4. oAuth Erişim belirteci düğmesini tıklatın.

  5. Erişim belirtecini oluşturun.

  6. Dene düğmesini tıklatın.

    Grup adı ve Grup Kimliği ile birlikte aşağıdaki gibi bir yanıt alırsınız:

    { 
      "groupInfoList": [ 
        { 
          "groupId": "3AAABLblqZhB4o9EnlvmGB_m8CrG5O6XClTBO7vmojOOexu5r3G95LtEV2Sp7BuhNvQYSvWB7PmmwVPXnhPIiYSuHV98Cerkp", 
          "groupName": "Default Group" 
        }, 
        { 
          "groupId": "3AAABLblqZhC3dPT6za5h7r1-BOEWivCe_OcAVONhcsKa57SL9_iCwGr5v_JED1No5jE20Pcjv0mYH2J-LoY1AcmqS69vRkO7", 
          "groupName": "test" 
        }, 
      ] 
    }

Grup silme:

  1. DELETE /groups/{groupId} seçeneğini tıklatın.

  2. Erişim Belirteci oluşturmak için OAuth Erişim Belirteci düğmesini tıklatın.

  3. Önceki çağrının yanıtında alınan grup kimliğini grup kimliği kutusunda silmek istediğiniz yere ekleyin.

  4. Deneyin'i tıklatın.

    Grup silindikten sonra bir şöyle bir yanıt alırsınız: No content

Not:

You cannot delete a group, which has a user assigned. Yalnızca boş bir Grubu silebilirsiniz. Grupta bir kullanıcı varsa aşağıdaki gibi bir yanıt alırsınız.


{

  "code": "GROUP_NOT_EMPTY",

  "message": "The group cannot be deleted because it is not empty."

}


Sözleşme Başlatma/Gönderme

Geçici belge oluşturma

  1. transientDocuments öğesini tıklatın ve POST /transientDocuments yöntemini genişletin

  2. OAuth Erişim belirteci düğmesini tıklatın

    API Geçici Belge Yöntemi

    • İşlem için Kapsamları etkinleştirin
    • Yetkilendir'i tıklatın
    OAuth Kapsamları

  3. Erişim İzni Ver

    Talep edilirse Erişim İzni Ver öğesini tıklatın

  4. API yöntemleri sayfasına dönersiniz. Yetkilendirme değeri artık doldurulmuştur.

    • Dosya Adı alanına dosya adını girin
    • Dosya Seç düğmesini tıklatın ve sözleşme için belgeyi yükleyin
    • Deneyin! düğmesini tıklatın
    Deneyin!

  5. Yanıt oluşturulur.

    transientDocumentID, Yanıt Gövdesinde bulunabilir:

    Geçici belge kimliği

Geçici belgeyi kullanarak Sözleşme Oluşturma

  1. Sözleşmeler'i tıklatın ve POST /agreements yöntemini genişletin

    • OAuth Erişim belirteci düğmesini tıklatın
    • OAuth kapsamını etkinleştirin
    • Yetkilendir'i tıklatın
      • Talep edilirse Erişim İzni Ver öğesini tıklatın
  2. API yöntemleri sayfasına dönersiniz. Yetkilendirme değeri artık doldurulmuştur.

    • Aşağıdaki komut dosyasını bir metin düzenleyiciye kopyalayın (bu komut dosyası çok az yapılandırılmış bir örnektir; üretim kodunuz farklı olacaktır)
    •  Aşağıdaki kodda belirtilen yere transientDocumentId değerinizi girin
    { 
      "fileInfos": [ 
       {"transientDocumentId":"PASTE YOUR TRANSIENTDOCUMENTID HERE"} 
      ], 
      "name": "test doc", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "noreply@echosign.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "DRAFT" 
    }

     

    • Özel komut dosyanızı kopyalayın ve AgreementInfo alanına yapıştırın
    • Deneyin! düğmesini tıklatın
    POST agreement yöntemi

  3. Yanıt oluşturulur.

    agreementID, Yanıt Gövdesinde bulunabilir:

    POST agreement yöntemi yanıtı

FileInfo parametresine dosya ekleme adımları aşağıda verilmiştir:

  1. Geçici kimlik kullanın:

    POST/transientDocuments'a gidin ve yerel sisteminizden kullanılacak belgeyi yükleyin.
    POST/Agreements'daki Dosya Bilgileri bölümü altında oluşturulan geçici kimliği kullanın:

    "fileInfos": [ 
         { 
           "transientDocumentId": "" 
         } 
       ],
  2. Kitaplık belgesi kimliğini kullanın:

    Gösterge paneline gidin. Belgeyi Kitaplığa Ekle'yi tıklatın ve şablonu kaydedin.
    REST API Belgeleri altında GET /libraryDocuments öğesini tıklatın ve oluşturulmakta olan şablon için Kitaplık Kimliği bilgisini alın.
    POST/Agreements altında kitaplık belgesi kimliğini girin:

    "libraryDocumentId": "", 
      "libraryDocumentName": "",
  3. Genel kullanıma Açık URL'yi kullanın:

    FileInfo parametresi altında kullanılacak genel erişime açık URL'yi sağlayın:

    { 
          "documentURL": { 
            "mimeType": "", 
            "name": "", 
            "url": "" 
          },
  1. Sözleşmeler> POST/agreements seçeneğini belirleyin. 

  2. Oauth Erişim belirteci seçeneğini belirleyin ve gerekli kapsamları sağlayın.

  3. Erişim belirteci eklendikten sonra aşağıdaki Talep Kodunu kullanabilirsiniz:

    { 
    "documentCreationInfo": { 
         "recipientSetInfos": [ 
              { 
                   "recipientSetRole": "SIGNER", 
                   "recipientSetMemberInfos": [{"email": "testemail@email.com"}] 
              }, 
              { 
                   "recipientSetRole": "SIGNER", 
                   "recipientSetMemberInfos": [{"email": "testemail@email.com"}] 
              } 
         ], 
         "signatureFlow": "SEQUENTIAL", 
         "name": "husband wife", 
         "signatureType": "ESIGN", 
         "fileInfos": [ 
    { 
    "transientDocumentId": "(SAMPLE VALUE)3AAABLblqZhAJ9H6e23kZAfBUbItPvIhHTEyA6eZhziEp4KSntYcULpo43OEXwuWiWa-IM1r1EExYW0044CjCkliP4WFL5yKBUDq5DYSmSxVlFypcD0at8kK-BX-Mu3T9c_3GUqgDg0ArX0MmzWT72GLR_0M4Jq--mtuqGzq-VK1s-WGR6GcbedVY7XWAf3b3h-SpE08Hc-iF3zO7jQzi9newXSl-iW2JJsb_55tggkyxkXAkj74C1WD6KkJzgblK0JU-seh6QPDd0Fv6_mfQe2EPQA31nXj50aXwD_xlUBq7mg5FeaBnZ5bzgoqIWGHkbyeD2taaFdw*"} 
    ] 
    } 
    }

POST /agreements çağrısında, signatureflow parametresi için Göndericiyi İlk ya da Son İmzalayan olarak eklemek üzere Pass SENDER_SIGNS_FIRST veya SENDER_SIGNS_LAST değerini girebilirsiniz.

JSON formatında bir çağrı örneği aşağıda verilmiştir:

{

  "documentCreationInfo": {

    "fileInfos": [

      {        "transientDocumentId":"3AAABLblqZ-yourIDGoesHere"

      }

    ],

    "name": "Test",

    "recipientSetInfos": [

      {

        "recipientSetMemberInfos": [

          {

            "email": "test@email.com"

          }

        ],

        "recipientSetRole": "SIGNER"

      }

    ],

    "signatureType": "ESIGN",

    "signatureFlow": "SENDER_SIGNS_FIRST"

  }

}

Not:

Şu Kişi adına Gönder seçeneği yalnızca Gelişmiş paylaşım özelliği ile REST API V6'da kullanılabilir.

Paylaşım sırasında Gönder izni verilmiyorsa veya Gelişmiş Paylaşım etkinleştirilmemişse aşağıdaki gibi bir yanıt alırsınız:

 

{"code":"PERMISSION_DENIED","message":"User provided in x-on-behalf-of-user header does not have required permission to perform this operation."}

 

Şu Kişi adına Gönder işlevinde, kullanıcıların hesaplarını paylaşırken diğer kullanıcılara gönderme izni verebilmelerini sağlamak için hesapta Gelişmiş Hesap Paylaşımı'nı etkinleştirin. Gelişmiş paylaşım için Gelişmiş Hesap Paylaşımını Etkinleştirme bölümüne bakın.

Şu Kişi adına Gönder işlevini kullanmak için Kullanıcı paylaşımı etkinleştirildikten sonra şu adımları izleyin:

Geçici belge oluşturma:

  1. transientDocuments altında POST /transientDocuments'ı tıklatın.

  2. Yetkilendirme için belirteç oluşturmak üzere OAUTH ERİŞİM BELİRTECİ düğmesini tıklatın.

  3. x-on-behalf-of-user alanında, adına gönderim yapmak istediğiniz kullanıcının e-posta adresini şu formatta girin: e-posta:test@email.com

  4. Dosya seçmek için Dosya Seç'i ve Dene'yi tıklatın.

    transientDocumentId ile aşağıdaki gibi bir yanıt alırsınız:

    {"transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*"}

Geçici belgeyi kullanarak sözleşme oluşturma:

  1. Sözleşmeler altında, POST /agreements'ı tıklatın.

  2. Yetkilendirme için belirteç oluşturmak üzere OAUTH ERİŞİM BELİRTECİ düğmesini tıklatın.

  3. x-on-behalf-of-user alanında, Geçici belge oluştururken yapıldığı gibi kullanıcının e-posta adresini girin.

  4. AgreementInfo'da aşağıdaki kodu ekleyin ve Dene'yi tıklatın.

    { 
      "fileInfos": [ 
        {    "transientDocumentId":"3AAABLblqZhB9Mjo0mrIu_pSgrf5VsMaKM68_Vmn80cimaqiUAD2OxrPp2e5H8GvjfiOxj4d5B8bCPkUfvaozW3KLisp_wseGVOL8A7oNZni1DWyFi4uNoxLQu4nUO44Wh63GQv9_HEJMePust0Pk94vJ_rbS96R7ic-vl7jbOkN0b4EB5-JMqlC-Fl_Vpyz8I1EQUrM5I4nB9ztMov4ad00yiOtDw0tB-Y2t5JdzM07P-mpJmwYEl8Fq2IeDuWjcR2tV7qY7TNGX2CNyh9jt0aMyduHeYa0GABr69z8Hm76eKdtaM_1E1ggWj205fSrNcwJsnpSO278*" 
        } 
      ], 
      "name": "Test", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "signer@email.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "IN_PROCESS" 
    }

     

    agreementId ile aşağıdaki gibi bir yanıt alırsınız:

    { 
      
      "id": "CBJCHBCAABAAUlen3l_fzlj1Kbn_wGZAhYcIgN0J7Qtq" 
      
    }
  1. Adobe Sign'da oturum açın.

  2. Hesap>Adobe Sign API>API Bilgileri'ne gidin ve REST API Yöntemi Belgeleri'ni tıklatın.

    Web Kancası Kullanıcı Arabirimi

  3. POST /transientDocuments'a gidin, bir dosya yükleyin ve geçici bir Belge Kimliği oluşturun.

  4. Geçici Belge Kimliğini kopyalayın ve bunu POST /agreements yönteminde kullanın. Kutuya aşağıdaki JSON isteğini girin:

    { 
        "documentCreationInfo": { 
            "mergeFieldInfo": null, 
            "recipientSetInfos": [{ 
                    "signingOrder": null, 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "securityOptions": null, 
                        "email": "test1@gmail.com" 
                    }], 
                    "privateMessage": "Hello 1", 
                    "securityOptions": null 
                }, 
                { 
                    "signingOrder": null, 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "securityOptions": null, 
                        "email": "test2@gmail.com" 
                    }], 
                    "privateMessage": "Hello 2", 
                    "securityOptions": null 
                } 
            ], 
            "signatureType": "ESIGN", 
            "callbackInfo": null, 
            "message": "Please review and sign this document.", 
            "locale": "en_US", 
            "vaultingInfo": null, 
            "securityOptions": null, 
            "reminderFrequency": null, 
            "ccs": null, 
            "postSignOptions": null, 
            "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
            "daysUntilSigningDeadline": null, 
            "formFieldLayerTemplates": [], 
            "name": "Adobe Sign Agreement", 
            "formFields": null, 
            "fileInfos": [{ 
                "libraryDocumentName": null, 
                "transientDocumentId": "XXXXXXXXXXXX", 
                "documentURL": null, 
                "libraryDocumentId": null 
            }] 
        } 
    }
  5. JSON İsteğini yürütmek için Deneyin düğmesini tıklatın.

    Web Kancası Kullanıcı Arabirimi

    Doğru JSON, yanıtı sözleşme kimliğiyle geri döndürür.

    Web Kancası Kullanıcı Arabirimi

Aşağıda, açık parola belirlemek için kodu girebileceğiniz parametreler verilmiştir:

 

{

    "documentCreationInfo":

    [{

        "signatureType": "ESIGN",

               "recipientSetInfos": [{

            "recipientSetMemberInfos": [{

                "email": "abc@xyz.com"

            }],

                   

            "recipientSetRole": "SIGNER"

        }],

               "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

                   "fileInfos": [           {

            "libraryDocumentId": "3AAABLblqZhBsm_vH7TVzU3hRdbtWuvzfTKDvBzaKZTiehjO2eGTk5Rlu02K-0BYn8HBJVFTWOmT_BQlrofPBlrCdjiJ_JI-V"

        }       ],

               "name": "Open password to view document",

               "securityOptions": {

            "openPassword": "1234",

                     "protectOpen": true

        }

    }]

}

 

API kullanarak durumu "AUTHORING" (İÇERİK OLUŞTURMA) olacak şekilde sözleşme oluşturmak için aşağıdaki adımları uygulayın:

Post /agreements bölümüne gidin ve gerekli kapsamlarla Erişim belirteci oluşturun.

Talep kodunu aşağıdaki şekilde kullanın:

 

{

  "fileInfos": [

    {

      "transientDocumentId": "*********************"

    }

  ],

  "name": "A1",

  "participantSetsInfo": [

    {

      "memberInfos": [

        {

          "email": "abc@xyz.com"

        }

      ],

      "order": 1,

      "role": "SIGNER"

    }

  ],

  "signatureType": "ESIGN",

  "state": "AUTHORING"

}

 

v6'da bir sözleşme oluşturmak için bir dizi içerik oluşturma API'si bulunur. v5'te form alanları doğrudan POST /agreements api'sinde tüketilir. Ancak v6 sürümünde kullanıcı, v6 POST /agreements aracılığıyla AUTHORING (İÇERİK OLUŞTURMA) durumunda (state = AUTHORING) sözleşme oluşturabilir ve bu sözleşmenin belgelerine form alanları eklemek için herhangi bir zamanda PUT /agreements/ID/formFields'ı kullanabilir.

Adımlar aşağıdaki gibidir:

  1. REST API V6 belgelerine gidin ve POST/agreements yöntemini seçin.

  2. Aşağıdaki talep kodunu kullanın:

    { 
      "fileInfos": [ 
        { 
          "transientDocumentId": "***************************" 
        } 
      ], 
      "name": "test", 
      "participantSetsInfo": [ 
        { 
          "memberInfos": [ 
            { 
              "email": "abc@gmail.com" 
            } 
          ], 
          "order": 1, 
          "role": "SIGNER" 
        } 
      ], 
      "signatureType": "ESIGN", 
      "state": "AUTHORING" 
    }
  3. Aşağıdaki örnek taleple birlikte put /agreements/{agreementId}/formFields yöntemini kullanın:

    { 
      "fields": [ 
        { 
         "locations": [ 
              { 
                "height": 36, 
                "left": 75, 
                "pageNumber": "1", 
                "top": 200, 
                "width": 150 
              } 
            ], 
            "contentType": "SIGNATURE_BLOCK", 
            "name": "sigBlock1", 
            "inputType": "SIGNATURE", 
            "recipientIndex":1 
           } 
    ]}

     

    Talep tamamlandıktan sonra söz konusu alıcıya sözleşmeyi gönderir.

  1. Adobe Sign'da oturum açın.

  2. Hesap>Adobe Sign API>API Bilgileri'ne gidin ve REST API Yöntemi Belgeleri'ni tıklatın.

    Web Kancası Kullanıcı Arabirimi

  3. POST /transientDocuments'a gidin, bir dosya yükleyin ve geçici bir Belge Kimliği oluşturun.

  4. Geçici Belge Kimliğini kopyalayın ve bunu POST /agreements yönteminde kullanın. Kutuya aşağıdaki JSON isteğini girin:

    { 
        "documentCreationInfo": { 
            "recipientSetInfos": [{ 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "email": "test1@gmail.com" 
                    }], 
                    "privateMessage": "Hello 1" 
                }, 
                { 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "email": "test2@gmail.com" 
                    }], 
                    "privateMessage": "Hello 2" 
                } 
            ], 
            "signatureType": "ESIGN", 
            "message": "Please review and sign this document.", 
            "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
            "name": "Demo1", 
            "fileInfos": [{ 
                "transientDocumentId": "XXXXXXXXXX" 
            }], 
            "formFields": [{ 
                    "hidden": "1", 
                    "defaultValue": "test1@gmail.com", 
                    "name": "Signer Email (Applicant-1)", 
                    "inputType": "TEXT_FIELD", 
                    "readOnly": true, 
                    "locations": { 
                        "pageNumber": 1, 
                        "top": 100, 
                        "left": 100, 
                        "width": 100, 
                        "height": 30 
                    }, 
      
                    "contentType": "SIGNER_EMAIL" 
                }, 
                { 
                    "name": "Signature (Applicant-2)", 
                    "inputType": "SIGNATURE", 
                    "locations": { 
                        "pageNumber": 1, 
                        "top": 520, 
                        "left": 162, 
                        "width": 280, 
                        "height": 30 
                    }, 
                    "contentType": "SIGNATURE", 
                    "required": 1, 
                    "recipientIndex": 1 
                }, 
                { 
                    "name": "Signature (Applicant-3)", 
                    "inputType": "SIGNATURE", 
                    "locations": { 
                        "pageNumber": 2, 
                        "top": 312, 
                        "left": 154, 
                        "width": 280, 
                        "height": 30 
                    }, 
                    "contentType": "SIGNATURE", 
                    "required": 1, 
                    "recipientIndex": 1 
                }, 
                { 
                    "defaultValue": "017/09/2018", 
                    "displayFormatType": "DATE", 
                    "name": "Signature Date (Applicant-4)", 
                    "format": "DATE_DD_MM_YYYY", 
                    "inputType": "TEXT_FIELD", 
                    "readOnly": true, 
                    "locations": { 
                        "pageNumber": 2, 
                        "top": 260, 
                        "left": 90, 
                        "width": 80, 
                        "height": 30 
                    }, 
                    "contentType": "DATA", 
                    "required": 1, 
                    "recipientIndex": 1 
                }, 
                { 
                    "name": "Signature (Applicant-5)", 
                    "inputType": "SIGNATURE", 
                    "locations": { 
                        "pageNumber": 3, 
                        "top": 199, 
                        "left": 179, 
                        "width": 276, 
                        "height": 30 
                    }, 
                    "contentType ": "SIGNATURE", 
                    "required": 1, 
                    "recipientIndex": 1 
                }, 
                { 
                    "contentType": "SIGNATURE_DATE", 
                    "defaultValue": "06/07/2018", 
                    "displayFormatType": "DATE", 
                    "name": "Signature Date (Applicant-6)", 
                    "format": "DATE_DD_MM_YYYY", 
                    "inputType": "TEXT_FIELD", 
                    "readOnly": true, 
                    "locations": { 
                        "pageNumber": 3, 
                        "top": 188, 
                        "left": 488, 
                        "width": 76, 
                        "height": 25 
                    }, 
                    "required": 1, 
                    "recipientIndex": 1 
                }, 
                { 
                    "name": "Signature (Applicant-7)", 
                    "inputType": "SIGNATURE", 
                    "locations": { 
                        "pageNumber": 3, 
                        "top": 370, 
                        "left": 37, 
                        "width": 210, 
                        "height": 26 
                    }, 
                    "contentType ": "SIGNATURE", 
                    "required": 1, 
                    "recipientIndex": 2 
                }, 
                { 
                    "contentType ": "SIGNATURE_DATE", 
                    "defaultValue": "01/02/2018", 
                    "name": "Signature Date (Applicant-8)", 
                    "locations": { 
                        "pageNumber": 3, 
                        "top": 370, 
                        "left": 300, 
                        "width": 76, 
                        "height": 26 
                    }, 
                    "required": 1, 
                    "recipientIndex": 2 
      
                } 
            ] 
        } 
    }
  5. JSON İsteğini yürütmek için Deneyin düğmesini tıklatın.

    Web Kancası Kullanıcı Arabirimi

    Doğru JSON, yanıtı sözleşme kimliğiyle geri döndürür.

    Web Kancası Kullanıcı Arabirimi

  1. Adobe Sign'da oturum açın.

  2. Hesap>Adobe Sign API>API Bilgileri'ne gidin ve REST API Yöntemi Belgeleri'ni tıklatın.

    Fnord.

  3. POST /transientDocuments'a gidin, bir dosya yükleyin ve geçici bir Belge Kimliği oluşturun.

  4. Geçici Belge Kimliğini kopyalayın ve bunu POST /agreements yönteminde kullanın. Kutuya aşağıdaki JSON isteğini girin:

    { 
        "options": { 
            "noChrome": true, 
            "authoringRequested": true 
        }, 
        "documentCreationInfo": { 
            "recipientSetInfos": [{ 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "email": "test1@gmail.com" 
                    }], 
                    "privateMessage": "Hello 1" 
                }, 
                { 
                    "recipientSetRole": "SIGNER", 
                    "recipientSetMemberInfos": [{ 
                        "email": "test2@gmail.com" 
                    }], 
                    "privateMessage": "Hello 44" 
                } 
            ], 
            "signatureType": "ESIGN", 
            "message": "Please review and sign this document.", 
            "locale": "en_US", 
            "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED", 
            "formFieldLayerTemplates": [], 
            "name": "Adobe Sign Agreement", 
            "formFields": null, 
            "fileInfos": [{ 
                "libraryDocumentName": null, 
                "transientDocumentId": "XXXXXXXXXXXX" 
            }] 
        } 
    }
  5. JSON İsteğini yürütmek için Deneyin düğmesini tıklatın.

    Fnord.

    Doğru JSON, yanıtı sözleşme kimliğiyle geri döndürür.

    Fnord.

  6. Sözleşmeyi İçerik Oluşturma Modunda açmak için URL'yi kopyalayıp tarayıcının adres çubuğuna yapıştırın.

  7. Form alanlarını gerekli konuma sürükleyip bırakın.

  8. Sözleşmeyi imzaya göndermek için Gönder'i tıklatın. 

Sözleşme oluşturmak için POST /agreements'ı kullanın. Bu, sözleşmeyi imzalanması için gönderir ve istemciye yanıt olarak agreementID'yi geri döndürür. Aşağıda, Telefonla kimlik doğrulama yöntemi üzerinden sözleşme göndermek için kullanılan JSON formatı verilmiştir.

 

{

"documentCreationInfo": {

"mergeFieldInfo": null,

"recipientSetInfos": [{

"signingOrder": null,

"recipientSetRole": "SIGNER",

"recipientSetMemberInfos": [{

"securityOptions": null,

"email": "Signer@email.com"

}],

 

"privateMessage": null,

"securityOptions": [{

"authenticationMethod": "PHONE",

"phoneInfos": [{

"phone": "1111111111",

"countryCode": "+1"

}]

}]

}],

 

"signatureType": "ESIGN",

"callbackInfo": null,

"message": "Please review and sign this document.",

"locale": "en_US",

"vaultingInfo": null,

"securityOptions": null,

"reminderFrequency": null,

"ccs": null,

"postSignOptions": null,

"signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

"daysUntilSigningDeadline": null,

"formFieldLayerTemplates": [],

"name": "Adobe Sign Agreement-Phone authentication testing",

"formFields": null,

"fileInfos": [{

"libraryDocumentName": null,

"transientDocumentId": "3AAABLYourTransactionID",

"documentURL": null,

"libraryDocumentId": null

}]

},

 

"options": {

"autoLoginUser": true,

"authoringRequested": false,

"noChrome": true,

"sendThroughWeb": null,

"sendThroughWebOptions": null,

"locale": "en_US"

}

}

 

Aşağıdaki yöntemleri kullanarak verileri doğrudan form alanlarıyla birleştirebilirsiniz:

  • Kitaplık şablonu kullanma:

    FileInfo parametresi altında kitaplık şablonu kimliği kullanıyorsanız tam alan adını ve aşağıdaki bölüm altındaki ilişkili verileri girdiğinizden emin olun:

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

  • Geçici belge olarak yüklenen bir belgede metin etiketlerini kullanma:

    Geçici belge olarak kendisine metin etiketleri eklenmiş bir belge yüklerseniz aşağıdaki bölüm altında tam alan adını ve ilişkili verilerini sağladığınızdan emin olun:

 

"mergeFieldInfo": [

     {

       "defaultValue": "",

       "fieldName": ""

     }

   ],

 

Belirli form alanları (mergefield) için önceden doldurulmuş değerlere sahip API'yi kullanarak sözleşme nasıl gönderilir?

Bu çağrının ön koşulu öncelikle "Geçici Yükleme" adımını tamamlamak ve burada kullanılacak bir "transientDocumentId" almaktır (şunu kullanarak: secure.na1.echosign.com/public/docs/restapi/v5#!/transientDocuments/createTransientDocument).

  • Bu çağrı, belirli form alanları için varsayılan değerlerin verildiği "mergeFieldInfo" bölümünü içerir.
  • Bu, API çağrısında başka bir sistemden gelen verileri önceden doldurur.
  • Sözleşmedeki bu alanlar düzenlenebilir veya salt okunurdur.

 

Ön koşullar:

  1. Geçici Belge Kimliği
  2. Alan adları ve değerleri

 

Örnek istek çağrısı:

 

İstek:

POST /api/rest/v5/agreements HTTP/1.1

Host: api.na1.echosign.com (veya getbaseURis çağrısını kullanarak bulabileceğiniz parça adınızı belirtebilirsiniz: https://secure.na1.echosign.com/public/docs/restapi/v5#!/base_uris/getBaseUris

Erişim Belirteci: 2AAABLblqZhA_D1mluNKQP7py5vXtt-1UHl9NR25e_C3LnKTUH14IblbrXODbXGRozyr7ChBkJNM*

x-user-email: sender@yourdomain.com

Content-Type: application/json

Cache-Control: no-cache

 

{

   "documentCreationInfo": {

       "signatureType": "ESIGN",

       "recipientSetInfos": [

           {

               "recipientSetMemberInfos": [

                   {

                       "email": “signerEmail@domain.com"

                   }

               ],

               "recipientSetRole": "SIGNER"

           }

        ],

      

       "signatureFlow": "SENDER_SIGNATURE_NOT_REQUIRED",

       "message": "Please Sign this from us!",

       "fileInfos": [

           {

               "transientDocumentId": "3AAABLblqZhD1uP3ZnkJximC0JV1S677PR5xmybSJ-SJn6OtEy2tVqFyMN4xUAbhKTSkLw2Zb6HEF4zAGsrUd2ycoB8fFHQJhrci0O6267VztmIL4nCicSqvAjO7HckATHAsovVmuYwI9_FDDgHg0ogyti62L13HQFZIQRe9iyQMvvzbmksM7ODNK_HEepEKRCeJTtis9FOlz6uRCcIMNlbX_2GU8utWT"

           }

       ],

       "name": "MSA Edited”,

        "mergeFieldInfo": [

            {

                "fieldName": "AccountName",

                "defaultValue": "Sam's Garage"

            },

            {

                "fieldName": "AccountNumber",

                "defaultValue": "8756999"

            },

            {

                "fieldName": "Zip",

                "defaultValue": "94501"

            },

            {

                "fieldName": "City",

                "defaultValue": "CityVille"

            },

            {

                "fieldName": "State",

                "defaultValue": "CA"

            },

            {

                "fieldName": "Street",

                "defaultValue": "123 Some Road"

            },

            {

                "fieldName": "Title1",

                "defaultValue": "COO"

            },

            {

                "fieldName": "Description",

                "defaultValue": "Some new description here"

            }

        ]

   }

 

}

 

Bu çağrıya yanıt, sonraki çağrılar için sisteminizde saklamanız gereken "agreementId" olacaktır (signingUrl, status, formData vb.)

 

Yanıt:

{

  "agreementId": "3AAABLblqZhCf_7xDcrOgKFwAabp1S-OFfvUdHf2wJsSMwlB95_x_WdUeab67jOkJi1IJzWuSJ0zdNNKugS1blZB4LT5vNVyJ"

}

 

"post /megaSigns/{megaSignId}/views" yöntemi çalışırken "Requested view is not available for the resource in the current state" (İstenen görünüm, geçerli durumdaki kaynak için kullanılamıyor) hatası görüntüleniyor.

Bu hata, sağlanan ad parametresi değeri aşağıdaki talep kodunda geçersiz ise gösterilir:

{
  "name": " "
}

Örneğin, MegaSign sözleşmesi halihazırda "IN_PROCESS" (İMZA_SÜRECİNDE) ise değeri "AUTHORING" (İÇERİK OLUŞTURMA) olarak ayarlamak söz konusu hataya neden olur. Sağlanan değerin geçerli sözleşme durumuna uygun olduğundan emin olun.

"Put /megaSigns/{megaSignId}/state" yöntemi çalıştırılırken, "No value provided for MegaSign cancellation info (MegaSign iptal bilgileri için değer sağlanmadı)" şeklinde bir hata gösteriliyor.

Bu hata, talep kodunun şu parametrede eksik olması durumunda oluşur: 

 "megaSignCancellationInfo": {
    "comment": "",
    "notifyOthers": false
  }

"Minimal Şema"yı kullanmak yerine "Eksiksiz Model Şeması"nı tıklatın ve API çağrısını çalıştırmak için talep kodunu eksiksiz şekilde girin.

MegaSign sözleşmesinin durumunu değiştirmek için put /megaSigns/{megaSignId}/state çağrısını kullanın ve aşağıdaki adımları uygulayın:

  1. V6 için REST API Belgeleri'ne gidin ve 
    put /megaSigns/{megaSignId}/state yöntemini seçin.
  2. Yetkilendirme değeri ile If-Match ve megasignID'yi girin.
    • MegasignID almak için get /megaSigns öğesini kullanın
    • If-Match almak için get /megaSigns/{megaSignId} kullanın ve üstbilgi altında "Etag" öğesini bulun
  3. {
      "state": "CANCELED",
      "megaSignCancellationInfo": {
       "comment": "cancel",
       "notifyOthers": false
      }
    }

Web kancasını başarıyla kaydetmek için web kancası URL'si bu doğrulama isteğine 2XX yanıt koduyla karşılık verir ve ayrıca, aynı istemci kimliği değerini aşağıdaki iki yoldan biriyle geri gönderebilir:

  1. Yanıt üstbilgisinde X-AdobeSign-ClientId. Talepte geçirilen üstbilgi aynıdır ve yanıt olarak tekrar iletilir.
  2. X-AdobeSign-ClientId anahtarının bulunduğu JSON yanıt gövdesinde ve değeri, talepte gönderilen istemci kimliğiyle aynı değerde.

Adobe Sign, 2xx yanıtını X-AdobeSign-ClientId ile alır. Kullanıcı, web kancasında düzgün yapılandırılıp yapılandırılmadığını kontrol edebilir.

Web kancası Url'si beklenen davranışa göre yanıt vermiyor. Adobe Sign tarafından gönderilen her Gönderi bildiriminde URL, 2XX durum koduyla yanıt verir ve talep üstbilgilerinde ( X-AdobeSign-ClientId) gönderilen istemci kimliğine yanıt üstbilgilerinde karşılık verir.

Daha ayrıntılı bilgi için şu bağlantıya bakın:
https://www.adobe.io/apis/documentcloud/sign/docs.html#!adobedocs/adobe-sign/master/webhooks/webhook_events.md

URL bu protokole uymadığında Adobe Sign, URL'nin talebi almadığını düşünür ve güvenilirlik politikasına göre yeniden planlama yapmaya çalışır.

Web kancası yanıt vermezse ve maksimum yeniden deneme süresi ya da maksimum yeniden deneme aralığı aşılırsa web kancası devre dışı bırakılır.

Bu çalışma Creative Commons Attribution-Noncommercial-Share Alike 3.0 Unported License kapsamında lisanslanmıştır  Creative Co şartları, Twitter™ ve Facebook sitelerinde paylaşılanları kapsamaz


Sözleşmelerle ilgili Bilgileri yönetme/alma

İmza için halihazırda gönderilmiş olan belgeyi değiştirmek için mevcut bir sözleşmeyi güncelleyebileceğiniz PUT /agreements/{agreementId} yöntemini kullanın. Aşağıdaki talep kodunda sözleşme kimliği ile birlikte geçici kimliği girin:

 

{

  "documentUpdateInfo": {

    "fileInfos": [

      {

        "agreementDocumentId": "",

        "transientDocumentId": ""

      }

    ]

  }

}

 

Aşağıda, Put /agreements/{agreementId}/state kullanarak durumu "AUTHORING" (İÇERİK OLUŞTURMA) durumundan "IN_PROCESS" (İMZA_SÜRECİNDE) durumuna güncellemeye yönelik talimatlar yer almaktadır:

  1. POST/Agreement yöntemini kullanarak sözleşme kimliğini alın.

  2. En son ETag'i almak için Get /agreements/{agreementId} çağrısını kullanın.

  3. Put /agreements/{agreementId}/state'e gidin ve şu bilgileri girin: "state": "IN_PROCESS"

Hayır.

Mevcut REST API'de imzalı bir kopya yüklemek için bir yöntem yoktur.

Gönderen, imzalanan kopyayı Yönet sayfasından yüklemelidir.

Yönet sayfasında bir sözleşmenin gizlenmesine izin vermek için DELETE /agreements/ID kullanılır.

Adobe, bir sözleşmenin (GET /agreements içinde) görünürlüğünü kontrol etmek için PUT /agreements/ID/me/visibility şeklinde yeni bir API'ye sahiptir. Yeni görünürlük uç noktası, DELETE /agreements/ID tarafından sağlanan işlevselliğe ek olarak kullanıcının "gizle" işlemini geri döndürmesine de olanak tanıyarak sözleşmenin tekrar görünür hale getirilmesini sağlar. 

Ayrıca aşağıdaki ayrıntılı adımları da takip edebilirsiniz:

  1. get /agreements yöntemine gidin ve sözleşme kimliğini alın.
  2. put /agreements/{agreementId}/me/visibility öğesini tıklatın ve aşağıdaki talebi örnek olarak girin:
    {
      "visibility": "HIDE"
    }
    Sözleşme kimliği yalnızca get /libraryDocuments öğesinden gizlenir ancak Yönet sekmesindeki kullanıcı arabiriminin altında hala görülebilir.
Not:

API Saklama özelliği varsayılan olarak etkin değildir.

DELETE/agreements işlemini etkinleştirmek için başarı yöneticiniz ile iletişime geçin ve hesabın API Saklama özelliğinin açılmasını isteyin.

Hesabınızın Saklama özelliklerini nasıl etkinleştireceğiniz hakkında daha fazla bilgi için Adobe Sign - Belge Saklama bölümüne bakın.

  1. Adobe Sign yöneticisi olarak oturum açın ve şu adrese gidin:  https://secure.adobesign.com/public/docs/restapi/v6

    • Sözleşmeler'i tıklatın ve GET /agreements yöntemini genişletin
    • OAUTH ERİŞİM BELİRTECİ düğmesini tıklatın
    • Agreement_read:self kapsamını etkinleştirin
    • Yetkilendir düğmesini tıklatın
      • Talep edilirse Erişim İzni Ver öğesini tıklatın
    • Deneyin! düğmesini tıklatın
    Get Agreement yöntemi

  2. Yanıt oluşturulur.

    agreementId, Yanıt Gövdesinde bulunabilir:

    Get Agreement yanıtı

  3. DELETE /agreements/{agreementId}/documents: Sözleşmeyle ilgili tüm belgeleri siler. Sözleşmenin kendisi Yönet sayfasında görünmeye devam eder.

    • Çalıştırılacak DELETE/agreements işlemini seçin.
    • OAUTH ERİŞİM BELİRTECİ düğmesini tıklatın ve agreement_retention kapsamı içeren bir erişim belirteci oluşturun.
    • Silmek istediğiniz sözleşmenin agreementId değerini girin.
    • Sözleşme silindikten sonra Yanıt Gövdesinde "içerik yok" mesajı görüntülenir.

DELETE/agreements işlemi etkinleştirilmemişse aşağıdaki yanıtı alırsınız:

 "code": "DYNAMIC_DOCUMENT_EXPIRATION_NOT_ENABLED",

  "message": "The operation requires some account settings to be enabled. Please contact the Adobe Sign team to enable the settings."

Denetim raporu indirmek için ayrı bir çağrı yapmak yerine aşağıdaki yöntemi kullanarak Denetim raporu ve destekleyici belgeyi Adobe Sign REST API üzerinden indirme.

GET /agreements/{agreementId}/auditTrail

  1. GET /agreements/{agreementId}/combinedDocument öğesini tıklatın.

  2. oAuth Erişim belirteci düğmesini tıklatın.

  3. Erişim belirteci, yetkilendirme kabul edildiğinde otomatik olarak oluşturulur.

  4. agreementId değerini girin.

  5. attachSupportingDocuments altında, açılır menüden true öğesini seçin.

  6. attachAuditReport altında, açılır menüden true öğesini seçin.

  7. Deneyin! düğmesini tıklatın.

    Belgeleri bir araya getirme

    Bu işlem, imzalanmış belge, destekleyici belge ve Denetim raporunu PDF dosyası olarak bir arada indirir.

Toplu belgeleri indirmek için yalnızca belge dışa aktarma aracı mevcuttur ve API ile belgeleri yalnızca tek tek indirebilirsiniz. Aşağıda, aynı işlem için API yöntemi verilmiştir:

https://secure.na1.adobesign.com/public/docs/restapi/v5#!/agreements/getCombinedDocument


Kitaplık Şablonları ve Web Formları

  1. Adobe Sign'da yönetici olarak oturum açın ve şu adrese gidin: https://secure.na1.adobesign.com/public/docs/restapi/v6

    • libraryDocuments'ı tıklatın ve GET /libraryDocuments yöntemini genişletin
    • OAUTH ERİŞİM BELİRTECİ düğmesini tıklatın
    • library_read:self kapsamını etkinleştirin
    • Yetkilendir düğmesini tıklatın
      • Talep edilirse Erişim İzni Ver öğesini tıklatın
    • Deneyin! düğmesini tıklatın
    Get LibraryDocument Yöntemi

  2. Yanıt oluşturulur.

    libraryDocumentId, Yanıt Gövdesinde bulunabilir:

    Get libraryDocument Yanıtı

Adobe sözleşmenin (GET /agreements) görünürlüğünü kontrol etmek için PUT/libraryDocuments/ID/me/visibility şeklinde yeni bir API çağrısına sahiptir. Yeni görünürlük uç noktası, DELETE /agreements/ID tarafından sağlanan işlevselliğe ek olarak kullanıcının "gizle" işlemini geri döndürmesine de olanak tanıyarak sözleşmenin tekrar görünür hale getirilmesini sağlar.

Aşağıdaki ayrıntılı adımları takip edebilirsiniz:

  1. get /libraryDocuments yöntemine gidin ve sözleşme kimliğini alın.
  2. put /libraryDocuments/{libraryDocumentId}/me/visibility öğesini tıklatın ve aşağıdaki talebi örnek olarak girin:
    {
      "visibility": "HIDE"
    }
    Kitaplık kimliği yalnızca get /libraryDocuments öğesinden gizlenir ancak Yönet sekmesindeki kullanıcı arabiriminin altında hala görülebilir.
Not:
  • Kitaplık silme işlemi için kapsamı etkinleştirmek amacıyla Destek ekibine bir talep gönderin.
  • API kitaplık belgesini siler. Ancak bu kitaplık belgesi kullanılarak oluşturulan sözleşmeler etkilenmez.


libraryDocumentID oluşturma

  1. https://secure.echosign.com/public/docs/restapi/v5 adresine gidin.

  2. libraryDocuments öğesini tıklatın.

  3. oAuth Erişim belirteci düğmesini tıklatın.

    Kendiniz, Grup veya Hesap için Erişimi Yetkilendirin.

  4.  libraryTemplateType Belgesini veya Form_field_layer'ı seçin.

  5. Deneyin'i tıklatın.

    Tüm şablonlarınız için aşağıdaki yanıtı alabilirsiniz. (Silmek istediğiniz Kitaplık Şablonu için libraryDocumentId öğesini kopyalayın).

    { 
      "libraryDocumentList": [ 
        { 
          "name": "testing fields", 
          "modifiedDate": "2017-08-04T01:06:05-07:00", 
          "scope": "PERSONAL", 
          "libraryDocumentId": "3AAABLblqZhAK53Dvzq88Q1Ov0TEvMAySDPpIVjF1PWgUpy0H1uYggt4iwGiRSZYlWfl9ms_AcmgZ_uZMPPN2hNT9izwaspHc", 
          "libraryTemplateTypes": [ 
            "DOCUMENT" 
          ] 
        },


Kitaplık Şablonlarını Silme

  1. Yanıt Gövdesinden libraryDocumentID öğesini kopyalayın.

  2. libraryDocuments'ı Sil öğesine gidin.

  3. oAuth Erişim belirteci düğmesini tıklatın. Kendiniz, Grup veya Hesap için Erişimi Yetkilendirin.

  4. libraryDocumentId'yi Değer alanına yapıştırın.

  5. Deneyin 
    düğmesini tıklatın. Şablon silinir.

    Şu Yanıt Kodunu alırsınız: 204

Not:

Yalnızca Draft (Taslak) durumundaki web formları güncellenebilir.

  1. Post /widgets'ı kullanarak widget oluşturun.

  2. get/widgets üzerinden widget kimliğini alın.

  3. GET /widgets/{widgetId} yöntemi kullanılarak oluşturulduktan sonra, Yanıt üstbilgisinden Etag'i getirin.

    Foo

  4. put  /widgets/{widgetId} altında GET /widgets/{widgetId} üzerinden Etag'i kullanın. If-Match parametresi altına widgetId ve widgetInfo öğelerini girin.

    Foo

    { 
      "fileInfos": [ 
        { 
          "transientDocumentId": "******" 
        } 
      ], 
      "name": "Widht_Name", 
      "status": "DRAFT", 
      "widgetParticipantSetInfo": { 
        "memberInfos": [ 
          { 
            "email": "" 
          } 
        ], 
        "role": "SIGNER" 
      } 
    }


Kullanım Senaryosu Örnekleri

  1. Doğru x-api-user ile get/agreements çağrısı yapın.

  2. Yanıt Gövdesi'nde, imza URL'sini bulmak istediğiniz imza sözleşmesini tespit edin ve sözleşme kimliğini not edin

  3. get/agreements çağrısından aldığınız sözleşme kimliğini kullanarak get/agreements/{agreementId}/signingUrls çağrısı yapın.

     

    Sonuç

    Çıktı, imzalayanların e-posta adresini ve e-imza URL'sini geri döndürür.

    Get Agreement Yöntemi

 Adobe

Daha hızlı ve daha kolay yardım alın

Yeni kullanıcı mısınız?

Adobe MAX 2024

Adobe MAX
Yaratıcılık Konferansı

14–16 Ekim Miami Beach ve çevrimiçi

Adobe MAX

Yaratıcılık Konferansı

14–16 Ekim Miami Beach ve çevrimiçi

Adobe MAX 2024

Adobe MAX
Yaratıcılık Konferansı

14–16 Ekim Miami Beach ve çevrimiçi

Adobe MAX

Yaratıcılık Konferansı

14–16 Ekim Miami Beach ve çevrimiçi