İstemci kimliğini almak, doğrulamak ve ardından yanıt üstbilgisinde geri döndürmek için örnek Javascript kodu
Son güncelleme:
10 Oca 2024
|
Ayrıca şunun için geçerlidir: Adobe Acrobat Sign
- Adobe Acrobat Sign Entegrasyonları
- Yenilikler
- Ürün Sürümler ve Yaşam Döngüsü
- Salesforce için Acrobat Sign
- Paketi yükleme
- Paketi yapılandırma
- Kullanıcı Kılavuzu
- Geliştirici Kılavuzu
- Gelişmiş Özelleştirme Kılavuzu
- Alan Eşleştirme ve Şablon Kılavuzu
- Mobil Uygulama Kullanıcı Kılavuzu
- Akış Otomasyonu Kılavuzu
- Document Builder Kılavuzu
- Büyük Belgeleri Yapılandırma
- Yükseltme Kılavuzu
- Sürüm Notları
- SSS
- Sorun Giderme Kılavuzu
- Ek Makaleler
- Microsoft için Acrobat Sign
- Microsoft 365 için Acrobat Sign
- Outlook için Acrobat Sign
- Word/PowerPoint için Acrobat Sign
- Teams için Acrobat Sign
- Microsoft PowerApps ve Power Automate için Acrobat Sign
- Microsoft Arama İşlevi için Acrobat Sign Bağlayıcı
- Microsoft Dynamics için Acrobat Sign
- Microsoft SharePoint için Acrobat Sign
- Genel Bakış
- SharePoint On-Prem: Kurulum Kılavuzu
- SharePoint On-Prem: Şablon Eşleştirme Kılavuzu
- SharePoint On-Prem: Kullanıcı Kılavuzu
- SharePoint On-Prem: Sürüm Notları
- SharePoint Online: Kurulum Kılavuzu
- SharePoint Online: Şablon Eşleştirme Kılavuzu
- SharePoint Online: Kullanıcı Kılavuzu
- SharePoint Online: Web Formu Eşleştirme Kılavuzu
- SharePoint Online: Sürüm Notları
- Microsoft 365 için Acrobat Sign
- ServiceNow için Acrobat Sign
- HR ServiceNow için Acrobat Sign
- SAP SuccessFactors için Acrobat Sign
- Workday için Acrobat Sign
- NetSuite için Acrobat Sign
- SugarCRM için Acrobat Sign
- VeevaVault için Acrobat Sign
- Coupa BSM Suite için Acrobat Sign
- Acrobat Sign Geliştirici Belgeleri
Genel Bakış
Web kancası, kaynak sitede (bu durumda Adobe Acrobat Sign) belirli bir olay meydana geldiğinde tetiklenen kullanıcı tanımlı bir HTTPS isteğidir.
Web kancası, veri veya veri akışını kabul eden bir REST hizmetidir.
Web kancaları, bir PUSH modelinde hizmetten hizmete iletişime yöneliktir.
Acrobat Sign, abone olunan olay tetiklendiğinde JSON gövdesine sahip bir HTTPS POST oluşturur ve bunu belirtilen URL'ye gönderir.
13.3 Genel
Web kancaları, önceki geri çağırma yöntemine kıyasla pek çok avantaj sunar. Bunlardan bazıları şunlardır:
- Yöneticiler, geri çağırma URL'sini listelemek için Acrobat Sign desteğini dahil etmek zorunda kalmadan kendi web kancalarını etkinleştirebilir
- Web kancaları veri "tazeliği, iletişim verimliliği ve güvenlik açısından daha iyidir. Sorgulama gerekmez
- Web kancaları, farklı kapsam düzeylerine (Hesap/Grup/Kullanıcı/Kaynak) kolayca izin verir. 13.3 Genel
- Web kancaları, modern uygulamalara daha kolay yapılandırma sağlayan daha anlaşılır bir API çözümüdür
- Geri Çağırmaların benzersiz olması gereken kapsam (Hesap/Grup/Kullanıcı/Kaynak) başına birden fazla web kancası yapılandırılabilir
- Geri çağırmaların "ya hep ya hiç" çözümü olduğu yerde web kancaları, döndürülecek verilerin seçimine izin verir
- Web kancası ile taşınan meta veriler yapılandırılabilir (Temel veya Ayrıntılı)
- Kullanıcı arabirimi tamamen yöneticinin kontrolünde olduğundan web kancalarını oluşturmak, düzenlemek veya devre dışı bırakmak çok daha kolaydır.
Not:
Bu belge, özellikle Acrobat Sign web uygulamasındaki (önceki adıyla Adobe Sign) Web Kancalarının kullanıcı arabirimine odaklanır.
API ayrıntılarını öğrenmek isteyen geliştiriciler daha fazla bilgiyi burada bulabilir:
Nasıl kullanılır?
Yöneticiler öncelikle Acrobat Sign'dan gelen push'u kabul etmeye hazır bir web kancası hizmetine sahip olmalıdır. Bu konuda pek çok seçenek vardır. İlgili hizmet POST ve GET isteklerini kabul edebildiği sürece web kancası başarılı olur.
Acrobat Sign yöneticisi, hizmet başlatıldıktan sonra Acrobat Sign sitesinin Hesap menüsündeki Web Kancası arabiriminden yeni bir web kancası oluşturabilir.
Yöneticiler, web kancasını Sözleşme, Web formu (Widget) veya Toplu Halde Gönderme (MegaSign) olaylarını tetikleyecek şekilde yapılandırabilir. Kitaplık Şablonu (Kitaplık Belgesi) kaynağı API aracılığıyla da yapılandırılabilir.
Web kancasının kapsamı, yönetici arabirimi aracılığıyla tüm hesabı veya bireysel grupları içerebilir. API, KULLANICI veya KAYNAK kapsamları tercihleri sayesinde daha fazla ayrıntılı seçim olanağı sağlar.
URL'ye gönderilen veri türü yapılandırılabilir ve Sözleşme Bilgileri, Katılımcı Bilgileri, Belge Bilgileri vb. öğeleri içerebilir.
Web kancası yapılandırılıp kaydedildikten sonra Acrobat Sign, abone olunan olayı her tetiklendiğinde tanımlanan URL'ye yeni bir JSON nesnesi gönderir. Olay tetikleme kriterlerini veya JSON yükünü değiştirmek istemediğiniz sürece web kancasının sürekli olarak değiştirilmesi gerekmez.
Web kancası URL'sinin amacını doğrulama
Acrobat Sign, bir web kancasını başarıyla kaydetmeden önce kayıt isteğinde sağlanan web kancası URL'sinin bildirim almayı isteyip istemediğini doğrular. Bu amaçla, Acrobat Sign yeni bir web kancası kayıt isteği aldığında, ilk olarak web kancası URL'sine bir doğrulama isteği gönderir. Bu doğrulama isteği, web kancası URL'sine gönderilen bir HTTPS GET isteğidir. Bu istekte özel bir HTTP üstbilgisi olan X-AdobeSign-ClientId vardır. Bu üstbilgideki değer, web kancasını oluşturmak/kaydetmek isteyen API uygulamasının istemci kimliği (Uygulama Kimliği) olarak ayarlanır. Web kancasını başarıyla kaydetmek için web kancası URL'sinin bu doğrulama isteğine 2XX yanıt koduyla karşılık vermesi VE ayrıca, aynı istemci kimliği değerini aşağıdaki iki yoldan biriyle geri göndermesi:
- Yanıt üstbilgisinde X-AdobeSign-ClientId. Bu, istekte iletilen ve yanıt olarak tekrar yansıtılan üstbilgiyle aynıdır.
- Alternatif olarak, xAdobeSignClientId anahtarına ve istekte gönderilen istemci kimliğiyle aynı değere sahip olacak şekilde JSON yanıt gövdesinde iletilir.
Web kancası, yalnızca başarılı bir yanıtta (2XX yanıt kodu) ve üstbilgide ya da yanıt gövdesinde müşteri kimliğinin doğrulanmasında başarıyla kaydedilecektir. Bu doğrulama isteğinin amacı, web kancası URL'nizin o URL'de bildirim almak istediğini göstermektir. Yanlış URL girdiğinizde URL, amaç isteğinin doğrulanmasına doğru şekilde yanıt veremez ve Acrobat Sign bu URL'ye hiçbir bildirim göndermez. Ayrıca web kancası URL'si, yalnızca belirli bir uygulamanın kaydettiği web kancaları aracılığıyla bildirim alacağını da doğrulayabilir. Bu işlem, X-AdobeSign-ClientId üstbilgisinde iletilen uygulamanın istemci kimliğini doğrulayarak yapılabilir. Web kancası URL'si bu istemci kimliğini tanımazsa başarılı yanıt koduyla yanıt vermemesi GEREKİR ve Acrobat Sign, URL'nin bir web kancası olarak kaydedilmemesine dikkat eder.
Web kancası URL çağrısının doğrulaması aşağıdaki senaryolarda gerçekleştirilir:
- Web Kancasını Kaydetme: Web kancası URL çağrısının bu doğrulaması başarısız olursa web kancası oluşturulmaz.
- Web Kancasını Güncelleme: ETKİN DEĞİL-ETKİN: Web kancası URL çağrısının bu doğrulaması başarısız olursa web kancası durumu ETKİN olarak değiştirilmez.
Web kancası bildirimine yanıt verme
Acrobat Sign, web kancası URL'sine gönderilen her web kancası bildirim isteğinde örtük bir amaç doğrulaması gerçekleştirir. Bu nedenle, her web kancası bildirimi HTTPS isteği, X-AdobeSign-ClientId adlı özel HTTP üstbilgisini de içerir. Bu üstbilginin değeri, web kancasını oluşturan uygulamanın istemci kimliğidir (Uygulama Kimliği). Web kancası bildiriminin başarılı bir şekilde teslim edildiğini ancak ve ancak, bir başarılı yanıt (2XX yanıt kodu) döndürülürse ve istemci kimliği, HTTP üstbilgisinde (X-AdobeSign-ClientId) veya JSON yanıt gövdesi aracılığıyla xAdobeSignClientId anahtarına ve müşteri kimliğiyle aynı değere sahip şekilde gönderilirse kabul ederiz. Aksi takdirde, yeniden denemeler bitene kadar bildirimi web kancası URL'sine göndermeyi yeniden deneriz.
Yukarıda belirtildiği gibi, Sign'dan gelen her bildirim isteğinde olan "X-AdobeSign-ClientId" üstbilgisinin (istemci kimliği) değeri yanıt olarak aşağıdaki yollardan biriyle tekrar belirtilmelidir:
1. X-AdobeSign-ClientId HTTP üstbilgisi ve bu istemci kimliğiyle aynı değer
|
|
|---|
|
// İstemci kimliğini getirin var clientid = request.headers['X-ADOBESIGN-CLIENTID']; 13.3 Genel //Onaylayın if (clientid ==="BGBQIIE7H253K6") //"BGBQIIE7H253K6" yerine web kancasının oluşturulduğu uygulamanın istemci kimliğini kullanın { //Yanıt üstbilgisinde geri döndürün response.headers['X-AdobeSign-ClientId'] = clientid; response.status = 200; // varsayılan değer } |
|
İstemci kimliğini almak, doğrulamak ve ardından yanıt üstbilgisine geri döndürmek için örnek PHP kodu |
|---|
|
<?php // İstemci kimliğini getirin $clientid = $_SERVER['HTTP_X_ADOBESIGN_CLIENTID']; //Onaylayın if($clientid == "BGBQIIE7H253K6") //"BGBQIIE7H253K6" yerine web kancasının oluşturulduğu uygulamanın istemci kimliğini kullanın { //Yanıt üstbilgisinde geri döndürün header("X-AdobeSign-ClientId:$clientid"); header("HTTP/1.1 200 OK"); // varsayılan değer } ?> |
2. xAdobeSignClientId anahtarına ve müşteri kimliğiyle aynı değere sahip JSON yanıt gövdesi
|
İstemci kimliğini almak, doğrulamak ve yanıt gövdesinde geri döndürmek için örnek Javascript kodu |
|---|
|
// İstemci kimliğini getirin var clientid = request.headers['X-ADOBESIGN-CLIENTID']; 13.3 Genel 13.3 Genel //Onaylayın if (clientid ==="BGBQIIE7H253K6") //"BGBQIIE7H253K6" yerine web kancasının oluşturulduğu uygulamanın istemci kimliğini kullanın { var responseBody = { "xAdobeSignClientId" : clientid // Gövdedeki istemci kimliğini geri döndürün }; response.headers['Content-Type'] = 'application/json'; response.body = responseBody; response.status = 200; } |
|
İstemci kimliğini almak, doğrulamak ve yanıt gövdesinde geri döndürmek için örnek PHP kodu |
|---|
|
<?php // İstemci kimliğini getirin $clientid = $_SERVER['HTTP_X_ADOBESIGN_CLIENTID']; //Onaylayın if($clientid == "BGBQIIE7H253K6") //"BGBQIIE7H253K6" yerine web kancasının oluşturulduğu uygulamanın istemci kimliğini kullanın { //Yanıt gövdesinde geri döndürün header("Content-Type: application/json"); $body = array('xAdobeSignClientId' => $clientid); echo json_encode($body); header("HTTP/1.1 200 OK"); // varsayılan değer } ?> |
|
Yanıtın örnek JSON gövdesi |
|---|
|
{ "xAdobeSignClientId": "BGBQIIE7H253K6" } |
Ön Koşullar
Şunlara ihtiyacınız vardır:
- Azure İşlevleri Uygulamaları oluşturma lisansına sahip bir Microsoft hesabı
- Mevcut bir Azure İşlevi Uygulaması. https://docs.microsoft.com/tr-tr/azure/azure-functions/functions-create-first-azure-function adresini kullanarak oluşturabilirsiniz
- Kodu istediğiniz dilde anlayıp yazabilmeniz için temel Javascript bilgileri
Acrobat Sign web kancası olarak hizmet veren bir Azure İşlevleri Tetikleyicisi oluşturma adımları
Javascript HTTP Tetikleyici işlevi oluşturmak için:
1. Microsoft hesabınız ile oturum açın https://portal.azure.com/
2. İşlev Uygulamaları sekmesi altında gösterilen Azure İşlev Uygulamanızı açın.
Azure İşlev Uygulamaları listeniz açılır:
3. Bu yeni işlevi oluşturmak istediğiniz uygulamayı seçin
4. Yeni bir Azure işlevi oluşturmak için Oluştur (+) düğmesini tıklatın
5. Senaryo olarak Web Kancası + API'yi, dil olarak da Javascript'i seçin
6. Bu işlevi oluştur öğesini tıklatın
Gelen bir API isteğini işleme yeteneğine sahip yeni bir işlev oluşturulur.
Acrobat Sign web kancasını kaydetmek için mantık ekleyin
Acrobat Sign, bir web kancasını başarıyla kaydetmeden önce kayıt isteğinde sağlanan web kancası URL'sinin gerçekten bildirim almayı isteyip istemediğini doğrular. Bu amaçla, Acrobat Sign yeni bir web kancası kayıt isteği aldığında ilk olarak web kancası URL'sine bir doğrulama isteği gönderir. Bu doğrulama isteği, X-AdobeSign-ClientId özel HTTP üstbilgisiyle web kancası URL'sine gönderilen bir HTTPS GET isteğidir. Bu üstbilgideki değer, web kancasını oluşturmak/kaydetmek isteyen uygulamanın istemci kimliğine ayarlanır. Web kancasını başarıyla kaydetmek için web kancası URL'sinin bu doğrulama isteğine 2XX yanıt koduyla karşılık vermesi VE ayrıca, aynı istemci kimliği değerini aşağıdaki iki yoldan biriyle geri göndermesi GEREKİR.
İzleyebileceğiniz iki seçenek vardır:
1. Seçenek: X-AdobeSign-ClientId içindeki İstemci Kimliğini yanıt Üstbilgisi olarak iletmek
X-AdobeSign-ClientId'yi yanıt üstbilgisinde iletmek. İstekte iletilen üstbilgi aynıdır ve yanıt olarak tekrar iletilmesi gerekir.
Index.js dosyasını aşağıdakilerle değiştirin:
module.exports = function (context, req) {
var clientId = req.headers['x-adobesign-clientid'];
// Gelen İstemci Kimliğinin orijinal olduğunu doğrulayın
if (clientId === '123XXX456') {
context.res = {
// status: 200, /* Varsayılan=200 */ // tüm 2XX yanıtları kabul edilir
body: "Notification Accepted",
headers : {
'x-adobesign-clientid' : req.headers['x-adobesign-clientid']
}
};
}
else {
context.res = {
status: 400,
body: "Opps!! Illegitimate Call identified"
};
}
context.done();
};
13.3 Genel
İsteği taklit ederek davranışı test edin:
1. En sağ köşedeki Test düğmesini tıklatın
2. Sahte isteği taklit edin
Yanıt üstbilgileri yukarıda gösterilmese de postman/DHC veya başka bir hizmet ile taklit ederek bunu gözlemleyebilirsiniz.
2. Seçenek: İstemci Kimliğini xAdobeSignClientId anahtarıyla yanıt gövdesinde iletin
xAdobeSignClientId anahtarına ve istek üstbilgisinde gönderilen istemci kimliğiyle aynı değere sahip olacak şekilde JSON yanıt gövdesinde.
Index.js dosyasını aşağıdakilerle değiştirin:
module.exports = function (context, req) {
var clientId = req.headers['x-adobesign-clientid'];
// Gelen İstemci Kimliğinin orijinal olduğunu doğrulayın
if (clientId === '123XXX456') {
context.res = {
// status: 200, /* Varsayılan=200 */ // tüm 2XX yanıtları kabul edilir
body: {
'xAdobeSignClientId' : clientId
},
headers : {
'Content-Type' : 'application/json'
}
};
}
else {
context.res = {
status: 400,
body: "Opps!! Illegitimate Call identified"
};
}
context.done();
};
İsteği taklit ederek davranışı test edin
1. En sağ köşedeki Test düğmesini tıklatın
2. Sahte isteği taklit edin
Ayrıca Web Kancası URL'si POST bildirimleri aldığında istemci kimliği için aynı davranışın beklendiğini unutmayın.
Kullanıma Hazır
Davranışı doğruladıktan sonra web kancası URL'si, Acrobat Sign standartlarına göre çalışır. Özel mantığı ihtiyaçlarınıza göre daha fazla güncelleyebilirsiniz.
İşlev URL'sini alma
- İşlev URL'sini al'ı tıklatın
URL'yi kopyalayıp Acrobat Sign'da web kancaları oluşturmak için kullanın.
AWS Lambda İşlevini Oluşturma
AWS Lambda işlevi oluşturmak için AWS Yönetim Konsolunuzda oturum açın ve hizmetler listesinden AWS Lambda hizmetini seçin.
- "Sıfırdan İçerik Oluştur"u kullanarak Lambda İşlevi Oluştur seçeneğini tıklatın
- İşlevi yapılandır sayfasında "lambdaWebhooks" işlev adını girin ve Çalışma Zamanı olarak Node.js 4.3'ü seçin
- Rol için mevcut bir rol seçin veya şablonlardan yeni bir rol oluşturun
- Şablonlardan yeni rol oluştur'u seçtiyseniz bir rol adı girip (ör. lambda rolü) Politika şablonları listesinden Basit Mikro Hizmetler izinleri'ni seçin
- İşlev oluştur düğmesini tıklatın
- Yeni AWS lambda işlev sayfasında, "Kod girişi türü" olarak "Kod satır içi düzenle" öğesini seçip index.handler seçeneğini İşleyici olarak tutun.
- Acrobat Sign Web Kancasını kaydetmek için mantık ekleyin
Acrobat Sign, bir web kancasını başarıyla kaydetmeden önce kayıt isteğinde sağlanan web kancası URL'sinin gerçekten bildirim almayı isteyip istemediğini doğrular. Bu amaçla, Acrobat Sign yeni bir web kancası kayıt isteği aldığında ilk olarak web kancası URL'sine bir doğrulama isteği gönderir. Bu doğrulama isteği, X-AdobeSign-ClientId özel HTTP üstbilgisiyle web kancası URL'sine gönderilen bir HTTPS GET isteğidir. Bu üstbilgideki değer, web kancasını oluşturmak/kaydetmek isteyen uygulamanın istemci kimliğine ayarlanır. Web kancasını başarıyla kaydetmek için web kancası URL'sinin bu doğrulama isteğine 2XX yanıt koduyla karşılık vermesi VE ayrıca, aynı istemci kimliği değerini aşağıdaki iki yoldan biriyle geri göndermesi GEREKİR. Ayrıca Web Kancası URL'si POST bildirimleri aldığında istemci kimliği için aynı davranışın beklendiğini unutmayın.
İki durumdan birini uygulayın:
1. Durum: X-AdobeSign-ClientId içindeki İstemci Kimliğini yanıt Üstbilgisi olarak iletmek
- X-AdobeSign-ClientId'yi yanıt üstbilgisinde iletmek. İstekte iletilen üstbilgi aynıdır ve yanıt olarak tekrar iletilmesi gerekir.
Kod Parçacığı
index.js dosyasında, otomatik olarak oluşturulan kod parçacığını aşağıdaki kodla değiştirin:
- X-AdobeSign-ClientId'yi yanıt üstbilgisinde iletmek. İstekte iletilen üstbilgi aynıdır ve yanıt olarak tekrar iletilmesi gerekir.
|
İstemci kimliğini almak, doğrulamak ve ardından yanıt başlığına geri döndürmek için örnek JS kodu |
|---|
|
exports.handler = function index(event, context, callback) { // İstemci kimliğini getirin var clientid = event.headers['X-AdobeSign-ClientId'];
//Onaylayın if (clientid == "BGBQIIE7H253K6") //"BGBQIIE7H253K6" yerine web kancasının oluşturulduğu uygulamanın istemci kimliğini kullanın { var response = { statusCode: 200, headers: { "X-AdobeSign-ClientId": clientid } }; callback(null,response); } else { callback("Oops!! illegitimate call"); } } |
2. Durum: İstemci Kimliğini xAdobeSignClientId anahtarıyla yanıt gövdesinde iletin
xAdobeSignClientId anahtarına ve istek üstbilgisinde gönderilen istemci kimliğiyle aynı değere sahip olacak şekilde JSON yanıt gövdesinde.
Kod Parçacığı
Index.js dosyasını aşağıdakilerle değiştirin:
|
İstemci kimliğini almak, doğrulamak ve ardından yanıt başlığına geri döndürmek için örnek JS kodu |
|---|
|
exports.handler = function index(event, context, callback) { // İstemci kimliğini getirin var clientid = event.headers['X-AdobeSign-ClientId'];
//Onaylayın if (clientid == "BGBQIIE7H253K6") //"BGBQIIE7H253K6" yerine web kancasının oluşturulduğu uygulamanın istemci kimliğini kullanın { var responseBody = { xAdobeSignClientId : clientid };
var response = { statusCode: 200, body: JSON.stringify(responseBody) };
callback(null,response); } else { callback("Opps!! illegitimate call"); } } |
- İşlevi kaydedin. Lambda işlevi oluşturulur ve gerçek zamanlı bir web kancasında kullanıma neredeyse hazırız hale geliriz.
AWS API Ağ Geçidini Yapılandırma
Bu Lambda'yı, HTTP yöntemi aracılığıyla herkes tarafından erişilebilir hale getirmek için API'de arka uç olarak işlevimizi (yukarıda oluşturulan) kullanarak AWS API Ağ Geçidini yapılandırmamız gerekir.
AWS Yönetim Konsolu'nda AWS hizmetlerinden API Ağ Geçidi'ni seçip API Oluştur düğmesini tıklatın
- Yeni API oluştursayfasında Yeni API'yi seçip API adı olarak web kancaları'nı girin.
- API Oluştur düğmesini tıklatın
- İşlemler açılır listesini ve Kaynak Oluştur'u seçin
- Proxy kaynağı olarak yapılandır seçeneğini işaretleyin, Kaynak Adı olarak doğrula'yı ve Kaynak Yolu'na da {proxy+} ifadesini girin
- API Ağ Geçidi CORS'i Etkinleştir seçeneğini işaretlemeden bırakın veKaynak Oluştur düğmesini tıklatın
- Entegrasyon türü olarak Lambda İşlevi Proxy'si'ni seçili tutun ve Lambda bölgesi açılır listesinde Lambda işlevinizi oluşturduğunuz bölgeyi seçin (muhtemelen API Ağ Geçidini oluşturduğunuz bölgedir).
- Lambda İşlevi olarak doğrula'yı girip Kaydet düğmesini tıklatın.
- Lambda İşlevine İzin Ekle açılır penceresinde Tamam'ı seçin
Yukarıdaki tüm adımlar başarıyla gerçekleştirilirse şuna benzer bir şey görürsünüz:
API Dağıtımı
Bir sonraki adım, kullanıma hazır hale getirmek için bu API'yi dağıtmaktır.
- İşlemler açılır listesinde API'yi dağıt'ı seçin
- Dağıtım aşamasında [Yeni Aşama] seçeneğini işaretleyip Aşama adına üret ifadesini (ya da bu aşamayı tanımlamak istediğiniz herhangi bir şeyi) girin
- Dağıt düğmesini tıklatın
API artık kullanıma hazırdır ve aşağıda gösterildiği gibi mavi kutuda çağrı URL'sini bulabilirsiniz:
Gerçek zamanlı web kancası URL'niz olarak girmeniz gerekeceğinden bu URL'yi not edin.
Kullanıma Hazır
İşte bu kadar. Bu yukarıdaki URL'yi, POST /web kancaları API isteğinde web kancası URL'si olarak eklenen "/{nodeJSfunctionName}" ile kullanın. Davranışı doğruladıktan sonra Web Kancası URL'si,
Acrobat Sign standartlarına göre çalışır. Özel mantığı ihtiyaçlarınıza göre ekleyebilir/daha fazla güncelleyebilirsiniz.
Yapılandırma seçenekleri
Web kancasını yapılandırmak için beş öğenin tanımlanması gerekir:
- Ad: Diğer yöneticilerin kolayca anlayabileceği sezgisel bir ad önerilir.
- Kapsam: Web kancasının yakalayacağı ağ genişliği nedir? 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 gönderme işlemini tetikleyen durumlar.
- Her olay, tetikleyici olayla ilgili farklı bir yük oluşturur.
- Tek bir web kancasına birden fazla Olay eklenebilir.
- Bildirim Parametreleri: Bildirim Parametreleri, Olay JSON yükünün bölümlerini tanımlar. Bu şekilde yalnızca bu web kancası için önemli olan Olay bölümlerini seçebilirsiniz (böylelikle URL'nize gönderilen gereksiz veriler azaltılır).
Web kancası tam olarak tanımlandıktan sonra Kaydet'i tıklatın; yeni web kancası tetiklenen olaylara anında yanıt vermeye başlayacaktır.
Not:
Lütfen web kancası URL'nizi, yukarıda açıklanan doğrulama protokolüne göre web kancası doğrulama ve web kancası bildirim isteklerine yanıt verecek şekilde yapılandırın. Acrobat Sign web uygulamasından oluşturulan web kancalarına gönderilecek istemci kimliği (Uygulama Kimliği) UB7E5BXCXY olacaktır.
Kapsamlar
- Hesap: Hesapta meydana gelen tüm abone olunan olaylar gönderme işlemini tetikler.
- Hesap yöneticileri, hesap için tanımlanan tüm web kancalarını ve bu hesap içerisindeki tüm grupları görme yetkisine sahiptir.
- Grup: Hesapta meydana gelen tüm abone olunan olaylar gönderme işlemini tetikler. NOT: Grup kapsamı bulunan web kancaları yalnızca o grup için mevcuttur.
- Grup yöneticileri yalnızca kendi gruplarına ayrılmış web kancalarını görür. Hesap düzeyinde web kancalarını veya diğer gruplara bağlı web kancalarını göremezler.
- Birden Fazla Gruptaki Kullanıcılar seçeneğinin etkin olduğu hesaplarda, kapsamın uygulanması gereken grubu belirleme seçeneği görünür.
- Kullanıcı Hesabı: Bir kullanıcı hesabı için abone olunan tüm olaylar gönderme işlemini tetikler. Kullanıcı düzeyinde web kancaları yalnızca API aracılığıyla oluşturulabilir.
- Kaynak düzeyinde web kancası: Belirli bir kaynak için oluşturulur. Bu kaynağa özel olaylar, web kancası URL'sine gönderilir. Kaynak düzeyinde web kancaları yalnızca API aracılığıyla oluşturulabilir.
URL
Web kancası URL'si, olaylar meydana geldiğinde tetiklenen, gelen HTTPS POST bildirim mesajlarını dinleyen bir sunucudur.
Olaylara yönelik web kancanıza abone olmak için bu URL'ye ihtiyacınız vardır.
- İstemcide, Acrobat Sign'ın GÖNDERİM yapabileceği bir HTTPS URL'si olmalıdır. Bu URL herkese açık internette bulunmalıdır.
- Örneğin, 127.0.0.1 olduğunda yerel ana makine URL'leri çalışmayacaktır.
- URL uç noktası 443 veya 8443 numaralı bağlantı noktasını dinliyor olmalıdır (geri çağırma URL'sini tanımlarken müşteri tarafından belirlenir).
- Web kancasının, gelen olay bildirimleri için POST isteklerini ve doğrulama isteği için GET isteklerini desteklediğinden emin olun.
- URL, güvenlik duvarı tarafından engellenmemelidir.
Aşağıda, nesneye göre gruplandırılmış ve kullanıcı arabirimindeki sıraya göre listelenmiş web kancası URL'sine push işlemini tetikleyebilecek olaylar yer almaktadır.
Soldaki değer Acrobat Sign kullanıcı arabiriminde göreceğiniz değerdir. Sağdaki değer API'deki web kancası adıdır.
Web kancaları ve yükleriyle ilgili tüm ayrıntılar için Acrobat Sign geliştirici kılavuzuna bakın.
Sözleşmeler:
| Kullanıcı Arabirimi Öğesi | Web kancası adı |
| Sözleşme tüm olaylar | AGREEMENT_ALL |
| Sözleşme oluşturuldu | AGREEMENT_CREATED |
| Sözleşme gönderildi | AGREEMENT_ACTION_REQUESTED |
| Sözleşme katılımcısı tamamlandı | AGREEMENT_ACTION_COMPLETED |
| Sözleşme iş akışı tamamlandı | AGREEMENT_WORKFLOW_COMPLETED |
| Sözleşmenin süresi doldu | AGREEMENT_EXPIRED |
| Sözleşme silindi | AGREEMENT_DOCUMENTS_DELETED |
| Sözleşme iptal edildi | AGREEMENT_RECALLED |
| Sözleşme reddedildi | AGREEMENT_REJECTED |
| Sözleşme paylaşıldı | AGREEMENT_SHARED |
| Sözleşme delege edildi | AGREEMENT_ACTION_DELEGATED |
| Sözleşme katılımcısı değiştirildi | AGREEMENT_ACTION_REPLACED_SIGNER |
| Sözleşme değiştirildi | AGREEMENT_MODIFIED |
| Sözleşmenin değiştirilmesi teyit edildi | AGREEMENT_USER_ACK_AGREEMENT_MODIFIED |
| Sözleşme e-postası görüntülendi | AGREEMENT_EMAIL_VIEWED |
| Sözleşme e-postası geri döndü | AGREEMENT_EMAIL_BOUNCED |
| Sözleşme oluşturulamadı | AGREEMENT_AUTO_CANCELLED_CONVERSION_PROBLEM |
| Sözleşme çevrimdışı olay sonrasında senkronize edildi | AGREEMENT_OFFLINE_SYNC |
| Sözleşme gönderen tarafından yüklendi | AGREEMENT_UPLOADED_BY_SENDER |
| Sözleşme kasaya koyuldu | AGREEMENT_VAULTED |
| Sözleşme katılımcısının sosyal kimliği doğrulandı | AGREEMENT_WEB_IDENTITY_AUTHENTICATED |
| Sözleşme katılımcısının kimliği KBA yöntemiyle doğrulandı | AGREEMENT_KBA_AUTHENTICATED |
| Sözleşme hatırlatıcı gönderildi | AGREEMENT_REMINDER_SENT |
| İmzalayan, sözleşme imzalayan adını değiştirdi | AGREEMENT_SIGNER_NAME_CHANGED_BY_SIGNER |
| Sözleşme Web kancaları yalnızca API üzerinden kullanılabilir | |
| NA | AGREEMENT_EXPIRATION_UPDATED |
| NA |
AGREEMENT_READY_TO_NOTARIZE |
| NA |
AGREEMENT_READY_TO_VAULT |
Toplu Halde Gönder:
| Kullanıcı Arabirimi Öğesi | Web kancası adı |
| Toplu Hâlde Gönder tüm olaylar | MEGASIGN_ALL |
| Toplu Halde Gönder ile oluşturulanlar |
MEGASIGN_CREATED |
| Toplu Halde Gönder ile paylaşılanlar |
MEGASIGN_SHARED |
| Toplu Halde Gönder ile geri çağırılanlar |
MEGASIGN_RECALLED |
Web Formları:
| Kullanıcı Arabirimi Öğesi | Web kancası adı |
| Web Formuyla ilgili tüm olaylar | WIDGET_ALL |
| Web Formu oluşturuldu |
WIDGET_CREATED |
| Web Formu etkinleştirildi |
WIDGET_ENABLED |
| Web Formu devre dışı bırakıldı |
WIDGET_DISABLED |
| Web Formu değiştirildi |
WIDGET_MODIFIED |
| Web Formu paylaşıldı |
WIDGET_SHARED |
| Web Formu oluşturulamadı |
WIDGET_AUTO_CANCELLED_CONVERSION_PROBLEM |
Kitaplık şablonları (Yalnızca API):
| Kullanıcı Arabirimi Öğesi | Web kancası adı |
| NA | LIBRARY_DOCUMENT_ALL |
| NA | LIBRARY_DOCUMENT_CREATED |
| NA | LIBRARY_DOCUMENT_AUTO_CANCELLED_CONVERSION_PROBLEM |
| NA | LIBRARY_DOCUMENT_MODIFIED |
Bildirim Parametreleri
Bildirim Parametreleri, JSON yükünü yalnızca olayın belirli öğelerine göre özelleştirmenizi sağlar.
Örneğin Sözleşme katılımcısı değiştirildi olayında, Belge Bilgilerini dışarıda bırakarak ve web kancası URL'nize gönderilen toplam JSON boyutunu azaltarak yalnızca Sözleşme Bilgilerini ve Katılımcı Bilgilerini isteyebilirsiniz.
- Sözleşme
- Sözleşme Bilgileri: Tetikleyici olay sırasında sözleşmenin durumuna göre ayrıntılı sözleşme bilgileri.
- Sözleşme Belgesi Bilgileri: Olay sonucunda oluşturulan tüm belge bilgilerini içerir.
- Sözleşme Katılımcısı Bilgileri: Olayın bir sonucu olarak tüm katılımcı bilgilerini içerir.
- Sözleşme İmzalı Belge: İmzalanan PDF'yi sağlar.
- Sözleşme İş Akışı Tamamlandı ve Sözleşme Tüm Olaylar için geçerlidir.
- Toplu Halde Gönder
- Toplu Halde Gönder Bilgileri: Olayı tetikleyen Toplu Halde Gönder nesnesi hakkında ayrıntılı bilgiler.
- Web Formu
- Widget Bilgileri: Olayı tetikleyen web formu hakkında ayrıntılı bilgiler.
- Widget Belge Bilgileri: Web formuyla ilişkili belge bilgileri.
- Widget Katılımcı Bilgileri: Web formunda tanımlanan katılımcılar hakkında bilgiler.
İki yönlü SSL kimlik doğrulaması
Genellikle İstemci Tarafı SSL veya karşılıklı TLS olarak adlandırılan iki yönlü SSL, hem sunucunun hem de istemcinin (web tarayıcısı) kendilerini tanımlamak için sertifika sağladığı bir SSL modudur.
Hesap yöneticileri, Güvenlik Ayarları sayfasında istemci tarafı sertifikasını yapılandırabilir.
Acrobat Sign, web kancası URL'sine yük teslim ederken SSL sertifikalarını doğrular. SSL sertifika doğrulamasında başarısız olan web kancaları, JSON yükünü başarılı bir şekilde gönderemez.
İstemcinin (Acrobat Sign) ve dinleme hizmetinin kimliğini doğrulamak için İki yönlü SSL kullanarak web kancası URL'nize yalnızca Acrobat Sign'ın erişebildiğinden emin olun.
Web kancası, İş Ortağı Uygulaması tarafından oluşturulmuşsa web kancası bildirimlerini gönderirken kendisini tanımlamak için İş Ortağı Uygulamasının Hesabından (varsa) bir istemci sertifikası kullanır.
Aşağıda hem web sunucusu doğrulama işlemi hem de istemci sertifikasyon doğrulaması için en yaygın sorular vardır.
Web sunucusu doğrulaması
Bir web kancasının kaydı sırasında, Acrobat Sign web kancası sunucu URL'sini doğrular.
Müşteriler, Acrobat Sign'dan web kancası geri çağırma URL'sine bağlantı tamamlanamazsa web kancasına kaydolamaz.
Hayır.
Web kancası geri çağırma URL'si yalnızca 443 veya 8443 bağlantı noktasında HTTPS olabilir.
Acrobat Sign diğer tüm bağlantı noktalarına giden HTTPS trafiğini engeller.
Sunucu sertifikasını doğrulamanın iyi bir yolu, DigiCert® SSL Kurulum Tanı Aracını kullanmaktır.
Sadece ana bilgisayar adını girin, ör.: www.digicert.com
Genel sorunlar aşağıdakileri içerir:
- Sorun: Güvenilir olmayan bir CA veya kendi kendine imzalanmış sertifika kullanma
Düzeltme: Web kancası geri çağırma sunucusu için herkese açık bir CA tarafından verilen SSL sertifikasını kullanın.
- Sorun: Sunucu ara sertifikayı göndermiyor
Düzeltme: Ara sertifikaları web kancası geri çağırma sunucusuna yükleyin.
Ayrıntılı bilgiler için bkz. https://www.digicert.com/kb/ssl-certificate-installation.htm.
İstemci sertifikası doğrulaması
Bir web kancası için iki yönlü SSL kurmak amacıyla, yöneticinin özel anahtarı içeren bir .p12 (veya .pfx) yükleyin. Dosya müşteri hesabında güvenli şekilde depolanır ve yönetici istenen zamanda bunu kaldırmak için tam kontrole sahiptir.
İki yönlü bir web kancası kurulumunda, Acrobat Sign arayan/istemcidir ve çağrının müşteri hesabı adına Acrobat Sign tarafından yapıldığını kanıtlamak için özel anahtara ihtiyacı vardır.
-
İki yönlü SSL'nin etkinleştirildiğini doğrulayın
İki yönlü SSL, web kancası geri arama sunucusunda etkinleştirilmelidir.
Herhangi bir web kancasını kullanarak, web kancası geri arama URL'sine bağlanın. Aşağıdakileri almalısınız:
400 Hatalı İstek Gönderilen SSL sertifikası gerekmez
Bu, sunucunun istemcinin istemci sertifikalarını göndermesini beklediği anlamına gelir (yani: İki yönlü SSL sunucu için etkinleştirilir).
Yukarıdaki mesajı görmüyorsanız iki yönlü SSL etkinleştirilmedi.
Not:Postman kullanabilir ve web kancası geri arama URL'sine bir POST isteği yapabilirsiniz. Benzer bir sonuç almanız gerekir.
-
İstem kimlik bilgileri kendi kendine imzalı sertifika veya CA tarafından verilen sertifikadır. Bununla birlikte, aşağıdaki X.509 v3 uzantılarına minimum düzeyde uymalıdır:
X.509 v3 uzantı
Değer
ExtendedKeyUsage
clientAuth (OID: 1.3.6.1.5.5.7.3.2)
KeyUsage
digitalSignature
İstemci sertifikası, .p12 veya .pfx uzantısına sahip bir PKCS12 dosyası olmalı ve hem istemci sertifikasını (böylece sunucu istemcinin kimliğini doğrulayabilir) hem de istemcinin özel anahtarını (böylece istemci, sunucunun SSL tokalaşması sırasında doğrulaması için mesajları dijital olarak imzalayabilir) içermelidir.
P12 (pfx) dosyasını doğrulamak için openssl komutunu kullanın:
openssl pkcs12 -info -in outfile.p12
Özel anahtar için parola, istenmesi gereken özel anahtardır. Çıkış, hem sertifikaları hem de aşağıdakiler gibi Şifrelenmiş Özel Anahtarları içermelidir:
Çanta Özellikleri localKeyID: 9D BD 22 80 E7 B2 B7 58 9E AE C8 42 71 F0 39 E1 E7 2B 57 DB subject=/C=US/ST=California/L=San Jose/O=Adobe Inc./CN=sp.adobesignpreview.com issuer=/C=US/O=DigiCert Inc/CN=DigiCert TLS RSA SHA256 2020 CA1 -----SERTİFİKAYI BAŞLAT----- MIIGwDCCBaigAwIBAgIQAhJSKDdyQZjlbYO5MJAYOTANBgkqhkiG9w0BAQsFADBP MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMSkwJwYDVQQDEyBE ... JAKQLQ== -----SERTİFİKAYI BİTİR----- Çanta Özellikleri: <Özellik Yok> subject=/C=US/O=DigiCert Inc/CN=DigiCert TLS RSA SHA256 2020 CA1 issuer=/C=US/O=DigiCert Inc/OU=www.digicert.com/CN=DigiCert Global Root CA -----SERTİFİKAYI BAŞLAT----- MIIEvjCCA6agAwIBAgIQBtjZBNVYQ0b2ii+nVCJ+xDANBgkqhkiG9w0BAQsFADBh MQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3 ... -----SERTİFİKAYI BİTİR----- Çanta Özellikleri localKeyID: 9D BD 22 80 E7 B2 B7 58 9E AE C8 42 71 F0 39 E1 E7 2B 57 DB Anahtar Özellikleri: <Özellik Yok> -----ŞİFRELENMİŞ ÖZEL ANAHTARI BAŞLAT----- MIIFDjBABgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQI7eNh2qlsLPkCAggA ... FHE= -----ŞİFRELENMİŞ ÖZEL ANAHTARI BİTİR-----Sertifikalar en azından son varlık sertifikasını ve ara sertifikaları içermelidir. İdeal olarak, ayrıca kök CA sertifikasını içerecektir.
Uyarı:.p12 veya .pfx dosyasının parola korumalı olduğundan emin olun.
-
Kendi kendine imzalanan bir istemci sertifikası (isteğe bağlı) oluşturun
İstemci sertifikaları, ihtiyacınıza bağlı olarak CA tarafından verilmiş veya kendi kendine imzalanmış olabilir.
Kendi kendine imzalanmış bir istemci sertifikası oluşturmak için aşağıdaki openssl komutunu kullanın:
openssl req -newkey rsa:4096 -keyform PEM -keyout ca.key -x509 -days 3650 -outform PEM -out ca.cer
Dikkat:Kendi kendine imzalanmış CA sertifikaları olduğu için elde edilen dosyaları gizli tutun.
Sonra, istemci .p12 dosyasını oluşturun:
- SSL istemcisi için özel bir anahtar oluşturun:
openssl genrsa -out client.key 2048
- Bir sertifika isteği oluşturmak için istemcinin özel anahtarını kullanın:
openssl req -new -key client.key -out client.req
- Sertifika isteği ve CA sertifika/anahtarını kullanarak istemci sertifikasını yayınlayın:
openssl x509 -req -in client.req -CA ca.cer -CAkey ca.key -set_serial 101 -extensions client -days 365 -outform PEM -out client.cer
- İstemci sertifikasını ve özel anahtarı tarayıcılar tarafından kullanım için pkcs#12 formatına dönüştürün:
openssl pkcs12 -export -inkey client.key -in client.cer -out client.p12
- pkcs12 ihtiyacınız olan her şeye sahip olduğu için istemci özel anahtarını, istemci sertifikasını ve istemci dosyalarını kaldırın.
rm client.key client.cer client.req
- SSL istemcisi için özel bir anahtar oluşturun:
-
- İstemci PFX dosyasını Ayarlar > Sertifikalar yoluna yüklemek için Postman kullanın.
- İstemci sertifikasını eklemek için Sertifika Ekle seçeneğini belirleyin.
- HTTP başlığını x-adobesign-cliendid için yapılandırın:
Yapılandırıldığında web kancası geri arama URL'sine bir POST isteği gönderin.
200 yanıt almalısınız.
-
Neden Postman ile doğruladıktan sonra bile Acrobat Sign PFX dosyamı reddediyor?
Yukarıdaki pfx dosyası doğrulama işlemini izlediyseniz ve Acrobat Sign pfx dosyasını hala reddediyorsa dosya standart olmayan PKCS12 dosyası oluşturabilen bir Microsoft aracı tarafından oluşturulmuş olabilir.
Bu durumda, pfx dosyasından sertifikaları ve özel anahtar çıkarmak için openssl komutlarını kullanın ve ardından doğru formatlı bir PKCS12 dosyası oluşturun:
// Sertifikaları ve özel anahtarı pfx dosyasından ayıklayın openssl pkcs12 -info -in microsoftclientssl.pfx -passin pass:"" -out clientcert.crt -nokeys openssl pkcs12 -info -in microsoftclientssl.pfx -passin pass:"" -out clientcert.key -nodes -nocerts // Yeni PKCS12 dosyası oluşturun openssl pkcs12 -export -inkey clientcert.key -in clientcert.crt -out clientcert.pfx
Etkinleştirme veya devre dışı bırakma
Web kancaları özelliğine erişim, kurumsal plan hesapları için varsayılan olarak etkindir.
Grup düzeyindeki yöneticiler yalnızca kendi gruplarında çalışan Web Kancalarını oluşturabilir/kontrol edebilir.
Web Kancaları sayfasına erişim, Yönetici menüsünün sol tarafında bulunabilir: Hesap > Web Kancaları
Web kancasını etkinleştirme
Bir web kancası ilk olarak Etkin durumunda oluşturulur.
Acrobat Sign'ın Web Kancaları sayfasında varsayılan olarak Etkin web kancalarını görürsünüz.
Etkin olmayan bir web kancasını etkinleştirmek için:
- Web kancaları üstbilgi satırının sağındaki Seçenekler simgesini (üç yatay çizgi) tıklatın ve Tüm Web Kancalarını Göster'i seçin.
- Etkin olmayan web kancasını bir kez tıklatarak seçin
- Bu işlem, üstbilgi satırının hemen altındaki web kancası seçeneklerini gösterir
- Etkinleştir'i tıklatın
Etkin web kancası, bir sonraki olay tetiklendiği anda hedef URL'ye veri göndermeye başlar.
Web kancasını devre dışı bırakma
Web kancasını devre dışı bırakmak için
- Web Kancaları sayfasına gidin
- Devre dışı bırakmak istediğiniz web kancasını bir kez tıklatın
- Üstbilgi satırının altındaki menü öğelerinden Devre Dışı Bırak'ı seçin
- Devre dışı bırakılan web kancasında Devre Dışı durumu gösterilir
Web kancasını görüntüleme veya düzenleme
Web kancaları istenildiği zaman düzenlenebilir ve kaydedilebilir. Yeni bir yapılandırma kaydedildikten sonra da bu değişiklik hemen geçerli olur.
Yalnızca Olaylar ve Bildirim Parametreleri düzenlenebilir.
Ad, Kapsam veya URL'nin değiştirilmesi gerekiyorsa yeni bir web kancası oluşturulması gerekir.
Bir web kancasının parametrelerini düzenlemek için:
- Web Kancaları sayfasına gidin
- Düzenlemek istediğiniz web kancasını bir kez tıklatın
- Üstbilgi satırının altındaki Görüntüle/Düzenle seçeneğini tıklatın
- Gerekli değişiklikleri uygulayıp Kaydet'i tıklatın
Web kancasını silme
Bir web kancası istenildiği zaman silinebilir.
Silinen bir web kancası sistemde yok olacağı için silinen bir web kancasını kurtarmanız mümkün değildir.
Web kancalarının önce devre dışı bırakılması gerekmez.
Bir web kancasını silmek için:
- Web Kancaları'na gidin
- Silmek istediğiniz web kancasını bir kez tıklatarak seçin
- Üstbilgi satırının altındaki Sil seçeneğini tıklatın
- Web kancasını silmek istediğinizden emin olmak için karşınıza bir sorgulama çıkar. Tamam öğesini tıklatın
En İyi Uygulamalar
- Sunucuya giden HTTPS taleplerinin sayısını sınırlamak için belirli, gerekli olaylara abone olun. Web kancalarınızı ne kadar spesifik hâle getirirseniz incelemeniz gereken hacim de o kadar azalır.
- Yinelemelere karşı dirençli olun: Aynı web kancası URL'sini paylaşan birden fazla uygulamanız varsa ve aynı kullanıcı her uygulamayla eşlenmişse aynı olay, web kancanıza birden fazla kez gönderilir (uygulama başına bir kez). Bazı durumlarda web kancanız yinelenen olaylar alabilir. Web kancası uygulamanız buna karşı toleranslı olmalı ve olay kimliğine göre veri tekilleştirmesi yapılmalıdır.
- Web kancalarına her zaman hızlıca yanıt verin: Uygulamanızın, web kancası isteklerine yanıt vermesi için yalnızca beş saniyesi vardır. Uygulamanızın yanıt vermek için gerçek bir iş yapması gerekmediğinden, doğrulama isteği için bu nadiren sorun teşkil eder. Ancak bildirim istekleri söz konusu olduğunda, uygulamanız bu isteğe yanıt olarak genellikle zaman alan bir işlem gerçekleştirir. Beş saniye içinde yanıt verebilmeniz için ayrı bir iş parçacığı üzerinde veya bir kuyruk kullanarak eşzamanlı olmayan bir şekilde çalışmanız önerilir
- Eş zamanlı kullanımı yönetin: Bir kullanıcı arka arkaya birkaç değişiklik yaptığında, uygulamanızın aynı kullanıcı için neredeyse aynı anda birden fazla bildirim alması muhtemeldir. Eş zamanlı kullanımı yönetme konusunda dikkatli olmazsanız uygulamanız, aynı kullanıcı için aynı değişiklikleri birden fazla kez işleyebilir. Acrobat Sign web kancalarından yararlanmak için bilgilerin kullanımına dair net bir anlayış edinilmesi gerekir. Aşağıdaki gibi sorular sorduğunuzdan emin olun:
- Yükte hangi verileri döndürmek istiyorsunuz?
- Bu bilgilere kimler erişecek?
- Hangi kararlar veya raporlar oluşturulacak?
- İmzalanan belgeyi almayla ilgili öneriler: Belge yönetim sisteminizde, imzalanan PDF'yi Acrobat Sign'dan nasıl alacağınızı belirlerken göz önünde bulundurmanız gereken birkaç faktör vardır.
Bir web kancası oluştururken Sözleşme İmzalı Belge'nin seçilmesi tamamen kabul edilebilir olsa da tetikleyici bir olay (Sözleşme durumu tamamlandı gibi) söz konusu olduğunda belgeleri almak için Acrobat Sign API'yi kullanmayı düşünebilirsiniz.
Dikkate alınması gereken noktalar...
JSON boyut sınırlaması
JSON yük boyutu 10 MB ile sınırlıdır.
Bir olay daha büyük bir yük oluşturduğunda web kancası tetiklenir ancak koşullu parametre nitelikleri istekte mevcutsa yükün boyutunu azaltmak için kaldırılır.
"ConditionalParametersTrimmed", bu gerçekleştiğinde istemciye conditionalParameters bilgisinin kaldırıldığını bildirmek için yanıt olarak döndürülür.
"conditionalParametersTrimmed" kırpılan anahtarlarla ilgili bilgilerin olduğu bir dizi nesnesidir.
Kesme işlemi aşağıdaki sırayla yapılır:
- includeSignedDocuments
- includeParticipantsInfo
- includeDocumentsInfo
- includeDetailedInfo
İmzalanan belgeler önce kesilecek, ardından katılımcı bilgileri, belge bilgileri ve son olarak ayrıntılı bilgiler verilecektir.
Bu durum, örneğin imzalı belgeyi (taban 64 kodlu) de içeriyorsa bir sözleşme tamamlama olayında veya birden çok form alanı içeren bir sözleşmede olabilir.
Web kancası bildirimleri
Acrobat Sign web kancaları; kullanıcı, grubu veya hesapları için yapılandırılmış bir web kancası varsa bir sözleşmenin tüm katılımcıları için geçerli olan bildirimler gönderir.
Sözleşme etkinlikleri, söz konusu etkinliğin ilgili katılımcısı için yapılandırılmış bir web kancası varsa bu web kancası URL'sine bildirim gönderilecek şekilde işlenir. Başka bir deyişle web kancaları, web kancasının yapılandırıldığı grubun veya hesabın dışındakiler dahil tüm geçerli sözleşmelerdeki etkinlikler için tetiklenir.
Bildirimler yalnızca katılımcının dahil olduğu etkinlikler için gönderilir. Örneğin, bir sözleşmenin Göndereni hemen hemen her bildirimi alırken Alıcılar yalnızca sözleşmeye katıldıkları andan itibaren ve yalnızca dahil oldukları olaylar için bildirim alırlar.
Web kancası bildirimleri, Acrobat Sign'ın geçerli kimlik doğrulama ve görünürlük modelini uygular. Bu da kullanıcıların yalnızca katılımı başladığında bir sözleşmeye erişebildiği anlamına gelir.
Gönderen, üç imza sahibine imzalamaları için bir sözleşme gönderir.
- Gönderen hesabı için yapılandırılmış hesap düzeyinde bir WebhookX mevcuttur.
- 1. İmzalayan, Gönderen ile aynı hesabın üyesidir ancak farklı bir Gruptadır. Bu grup için de yapılandırılmış bir WebhookY vardır.
- 2. İmzalayan farklı bir Hesabın üyesidir ve 2. İmzalayanın hesabı için yapılandırılmış hesap düzeyinde bir WebhookZ vardır.
- 3. İmzalayan, Gönderen ile ayı hesabın üyesidir.
Gönderen bir sözleşme gönderir: WebhookX "Sözleşme oluşturuldu" ve "Sözleşme gönderildi" ile tetiklenirken WebhookY, "Sözleşme gönderildi" ile tetiklenir.
1. İmzalayan imza atar: WebhookX, "Sözleşme katılımcısı tamamlandı" ve "Sözleşme gönderildi” ile tetiklenir; WebhookY, "Sözleşme katılımcısı tamamlandı" ile tetiklenir ve WebhookZ "Sözleşme gönderildi" ile tetiklenir.
2. İmzalayan imza atar: WebhookX, "Sözleşme katılımcısı tamamlandı" ve "Sözleşme gönderildi" ile tetiklenirken WebhookZ, "Sözleşme katılımcısı tamamlandı" için bildirim gönderir.
3. İmzalayan imza atar: WebhookX, "Sözleşme katılımcısı tamamlandı" ve "Sözleşme iş akışı tamamlandı" ile tetiklenir; WebhookY, "Sözleşme iş akışı tamamlandı" ile tetiklenir ve WebhookZ, "Sözleşme iş akışı tamamlandı" ile tetiklenir.
Dinleme hizmeti kapalı olduğunda tekrar deneyin
Web kancası için hedef URL herhangi bir nedenle kapanırsa Acrobat 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.
Web kancası alıcısı 72 saat içinde yanıt vermezse ve son yedi gün içinde başarılı bir bildirim gönderimi gerçekleşmediyse web kancası devre dışı bırakılır. Web kancası tekrar etkinleştirilene kadar bu URL'ye bildirim gönderilmez.
Web kancasının devre dışı bırakıldığı ve ardından tekrar etkinleştirildiği zaman arasındaki tüm bildirimler kaybolur.
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