Aracılığıyla paylaş

BlueInk

Blueink bağlayıcısı, Blueink'in eSignature platformunu otomatik iş akışlarına eklemenize olanak tanır. Bağlayıcı, paket durumunu denetlemenize, yeni paketler oluşturmanıza, imzalayan bilgilerine erişmenize ve daha fazlasını yapmanızı sağlar.

Bu bağlayıcı aşağıdaki ürün ve bölgelerde kullanılabilir:

Hizmet Class Bölgeler
Copilot Studio Premium Aşağıdakiler dışında tüm Power Automate bölgeleri :
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Logic Apps Standart Aşağıdakiler dışında tüm Logic Apps bölgeleri :
     - Azure Kamu bölgeleri
     - Azure Çin bölgeleri
     - ABD Savunma Bakanlığı (DoD)
Power Apps Premium Aşağıdakiler dışında tüm Power Apps bölgeleri :
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
Power Automate Premium Aşağıdakiler dışında tüm Power Automate bölgeleri :
     - ABD Kamu (GCC)
     - US Government (GCC High)
     - 21Vianet tarafından işletilen Çin Bulutu
     - ABD Savunma Bakanlığı (DoD)
İletişim
İsim Blueink Desteği
URL https://help.blueink.com/en/
E-posta support@blueink.com
Bağlayıcı Meta Verileri
Publisher Blueink
Web sitesi https://blueink.com
Gizlilik ilkesi https://blueink.com/privacy-policy/
Kategoriler İş Yönetimi; Verimli -lik

Bu çok yönlü bağlayıcı ile kullanıcılar, çeşitli Power Automate bağlayıcılarının özelliklerinden yararlanarak Blueink'in güçlü eSignature çözümünü iş akışlarıyla sorunsuz bir şekilde tümleştirebilir. Bu tümleştirme, kullanıcıların belge paketlerinin oluşturulmasını ve dağıtılmasını zahmetsizce otomatikleştirmesini sağlar. Bu bağlayıcının diğer bağlayıcılarla uyumlu etkileşimini düzenleyerek belge yönetimi süreçlerinizi kolaylaştırabilir, verimliliği artırabilir ve müşterileriniz ve paydaşlarınız için sorunsuz ve verimli bir belge imzalama deneyimi sağlayabilirsiniz. İster sözleşme onaylarını otomatikleştirme, yasal belgeleri işleme, ister başka bir bağlamda evrak işlerini yönetme olsun, bu bağlayıcı iş akışınızı iyileştirmek ve üretkenliği artırmak için güçlü bir araç sağlar.

Önkoşullar

Bu bağlayıcıyı kullanmak için blueink.com API özellikli bir hesaba ihtiyacınız olacaktır.

Kimlik bilgilerini alma

Hesabınızı oluşturduktan sonra sayfanın sol tarafındaki API düğmesine tıklayın. Özel API Anahtarları'nın altında API Tuşu Ekle düğmesine basın. API anahtarına bir etiket verin ve submit tuşuna basın. API anahtarını kopyalayın ve bir yere kaydedin çünkü bir daha gösterilmez.

Bağlayıcınızı kullanmaya başlama

Blueink bağlantısını ilk oluşturduğunuzda bir API anahtarı girmeniz istenir. API anahtarınızın her zaman Belirteç ile başlaması ve ardından bir alan ve ardından oluşturduğunuz API anahtarı gerekir. API anahtarınızı girmeniz bu Belirteç <API ANAHTARı> gibi görünmelidir.

Popüler bir eylem, bir paket oluşturmaktır. Paket oluşturmak için karmaşık bir giriş kümesi gerekir. Gövde değişkeninin nasıl görünebileceğine ilişkin API belgelerimize https://blueink.com/esignature-api/api-docs/#tag/Bundles/operation/createBundle göz atın. Paket oluşturma gövdesi örneği olarak aşağıdaki resim.

Paket oluşturma

Paket oluşturmanın birden çok yolu vardır ve bu JSON'u oluşturmak istediğiniz pakete uyacak şekilde değiştirebilirsiniz. Bu JSON'un değiştirilebileceği diğer yollar için API'ye göz atın. Bu, kullanıcı tarafından kendi hesabında önceden oluşturulmuş bir şablon kullanır.

Tamamlanan paketlerin tümünü listelemek başka bir popüler uç noktadır. Paket Listele eylemini ekleyin ve ardından tamamlanmış paketler için durum düğmesini co olarak değiştirin. Bu uç noktayı kullanarak en son tamamlanan tüm paketlerinizi güncel tutabilirsiniz.

Paketleri listeleme

Bilinen sorunlar ve sınırlamalar

Paket oluşturma uç noktası için gövde JSON gereklidir

Yaygın hatalar ve çözümler

Geçersiz bir belirteç hatasıyla başarısız olan bir istekle ilgili bir hata alırsanız, API anahtarını yalnızca yapıştırmadığınızdan ve yukarıdaki Belirteç dizesinin ardından bir boşluk ve ardından API anahtarınızı eklemediğinizden emin olun.

Paket oluştururken geçersiz bir girişle ilgili hata alırsanız, Bunun Blueink'e gönderilen geçerli JSON olduğundan emin olun.

FAQ

1. Blueink nedir?

  • Blueink, belge imzalama işlemini basitleştirerek elektronik belgeleri güvenli bir şekilde göndermeyi, imzalamayı ve yönetmeyi kolaylaştıran gelişmiş bir eSignature çözümüdür.

2. Blueink için Microsoft Bağlayıcısı nedir?

  • Blueink için Microsoft Bağlayıcısı, kullanıcıların Blueink'in eSignature çözümünü Microsoft Power Automate ile sorunsuz bir şekilde tümleştirerek otomasyona ve gelişmiş belge yönetimine olanak tanıyan bir araçtır.

3. Blueink için Microsoft Bağlayıcısı nasıl çalışır?

  • Bağlayıcı, Blueink'i diğer Power Automate bağlayıcılarıyla birleştirerek otomatik iş akışları oluşturmanıza olanak tanır. Belge paketlerinin oluşturulmasını ve dağıtılmasını otomatikleştirerek belge yönetimi süreçlerinizi geliştirebilirsiniz.

4. Blueink için Microsoft Bağlayıcısı'na yönelik bazı kullanım örnekleri nelerdir?

  • Yaygın kullanım örnekleri arasında sözleşme onaylarını otomatikleştirme, yasal belgeleri yönetme, evrak işlemlerini kolaylaştırma ve müşteriler ve paydaşlar için sorunsuz ve verimli bir belge imzalama deneyimi sağlama yer alır.

5. Blueink için Microsoft Bağlayıcısı'nı diğer Microsoft ürünleriyle birlikte kullanabilir miyim?

  • Evet, bağlayıcı çeşitli Microsoft ürün ve hizmetleriyle sorunsuz çalışacak şekilde tasarlanmıştır ve Blueink eSignatures'ı Microsoft merkezli iş akışlarınızla tümleştirmenize olanak tanır.

6. Blueink için Microsoft Bağlayıcısı'nı ayarlamak ve kullanmak kolay mı?

  • Evet, kullanıcı dostudur ve basit olacak şekilde tasarlanmıştır. İş akışlarınızı özel belge yönetimi gereksinimlerinize uyacak şekilde yapılandırabilir ve özelleştirebilirsiniz.

7. Blueink için Microsoft Bağlayıcısı'nı kullanmanın herhangi bir maliyeti var mı?

  • Fiyatlandırma, kullanım ve lisans sözleşmelerinize göre farklılık gösterebilir. Belirli fiyatlandırma ayrıntıları için Blueink veya Microsoft ile kontrol etmek en iyisidir.

8. Blueink için Microsoft Bağlayıcısı ile ilgili teknik sorunlar için destek alabilir miyim?

  • Evet, Blueink ve Microsoft genellikle bağlayıcının kullanımıyla ilgili teknik sorunlara veya sorularınıza yardımcı olmak için destek kaynakları ve belgeler sunar.

9. Blueink için Microsoft Bağlayıcısı hem Windows hem de bulut tabanlı Microsoft hizmetleriyle uyumlu mu?

  • Evet, bağlayıcı hem şirket içi hem de bulut tabanlı Microsoft hizmetleriyle çalışacak şekilde tasarlanmıştır ve tümleştirme seçeneklerinizde esneklik sağlar.

10. Blueink için Microsoft Bağlayıcısı hakkında daha fazla bilgiyi nereden bulabilirim?

  • Kurulum kılavuzları ve belgeler de dahil olmak üzere ek bilgi için Blueink web sitesini ziyaret edebilir veya bu bağlayıcıyla ilgili Microsoft Power Automate belgelerini inceleyebilirsiniz.

Bağlantı oluşturma

Bağlayıcı aşağıdaki kimlik doğrulama türlerini destekler:
Varsayılan Bağlantı oluşturmak için parametreler. Tüm bölgeler Paylaşılamaz

Temerrüt

Geçerli: Tüm bölgeler

Bağlantı oluşturmak için parametreler.

Bu, paylaşılabilir bir bağlantı değildir. Power app başka bir kullanıcıyla paylaşılıyorsa, başka bir kullanıcıdan açıkça yeni bağlantı oluşturması istenir.

İsim Türü Description Gerekli
Blueink API Anahtarı securestring Blueink API anahtarınız. Bu, API sekmesinin altında Blueink'te oluşturulabilir. Doğru biçim, 'Token XXXXXX' biçimindedir; burada XXXXXX, API anahtarınızdır Doğru

Azaltma Sınırları

Name Çağrılar Yenileme Dönemi
Bağlantı başına API çağrıları 100 60 saniye

Eylemler

Anımsatıcı Gönder

İmzalayana Anımsatıcı e-postası veya SMS gönderin. Anımsatıcı yalnızca saatte bir gönderilebilir. Anımsatıcı, teslim yöntemi (e-posta veya SMS) ve daha önce bu Paket için belirlenen e-posta adresine (veya telefon numarasına) gönderilir.
Belge Şablonlarını Listele

Tüm Belge Şablonlarını Listele
Belge Şablonu Alma

Belge Şablonu Alma
Bir Kişiyi Güncelleştirme

Kişiyi yeni verilerle güncelleştirin. Bu istekten atlanmış olan tüm kişi kanallarının SİlİLEBİLeceğini unutmayın. Kişi üzerindeki tüm verileri değiştirmek istemiyorsanız, bunun yerine PATCH kullanmak isteyebilirsiniz.
Bir Kişiyi kısmen güncelleştirme

Kişiyi yeni verilerle kısmen güncelleştirin.

Kişiye yeni bir e-posta veya telefon eklemek için , 'kanallar' dizisine 'id' olmadan bir ContactChannel ekleyin.

Kişiyle ilişkilendirilmiş mevcut bir ContactChannel'i güncelleştirmek için bir 'id' ekleyin. Mevcut ContactChannel yeni e-posta veya telefon ile güncelleştirilecektir. Bu işlem, söz konusu e-postaya (veya telefona) gönderen Kişiyle ilişkili tüm canlı Paketleri güncelleştirir.

ContactChannel bir 'id' içermiyorsa, ancak e-posta (veya telefon) mevcut bir ContactChannel ile eşleşiyorsa, bu ContactChannel değiştirilmez.
Katıştırılmış İmzalama URL'si oluşturma

Ekli imzalama için kullanılabilecek bir URL oluşturma
Kişi Alma

Kimliğine Göre Kişi Alma
Kişi Oluşturma

Yeni bir kişi oluşturun. Bir kişi bir BlueInk Kullanıcısı ile ilişkilendirilebilir veya tek başına bir kişi olabilir. BlueInk Kullanıcısı ile ilişkili bir kişi oluşturmak istiyorsanız, alanı sağlamanız user_id gerekir. Tek başına bir kişi oluşturmak istiyorsanız, alanı sağlamanız name gerekir.
Kişi Silme

Kişi Silme. Bu, ilişkili tüm BlueInk Kullanıcılarını da siler.
Kişileri Listele

Hesabınızdaki Kişilerin listesini alın. İsteğe bağlı olarak bir arama sorgusu sağlayarak listeyi filtreleyebilirsiniz. Örneğin, "John" adlı tüm Kişiler'i aramak için sorgusunu search=Johnkullanabilirsiniz.
Paket Alma

Sümüklüböcek tarafından paket alma
Paket Dosyalarını Alma

Tamamlanmış bir Paket için indirilebilir dosyaları alma
Paket Kanıt Sertifikalarını Alma

Bu Paket için Kanıt Sertifikası'nın bağlantısını ve sağlama toplamını alın
Paket Listele

Hesabınızdaki paketlerden oluşturulan tarihe göre (en son ve en son) sıralanmış sayfalandırılmış bir paket listesi döndürür. Sayfalama, Sayfalama paramaterleri aracılığıyla denetlenebilir (bkz. Genel Bakış-Sayfalandırma>). Sorgu dizesi filtreleri paramaterleri birleştirilebilir, örneğin. /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention Filtreler bir araya getirildiğinde, yalnızca TÜM filtrelerle eşleşen Paketler döndürülür.
Paket Olaylarını Listele

Paketle ilişkili Olayların listesini alma
Paket Oluşturma

İmza için paket oluşturma ve gönderme
Paket Verilerini Alma

Tamamlanmış bir Paket için alanlara girilen verileri alma
Pakete Etiket ekleme

Pakete ek etiketler ekleyin. Pakette mevcut etiket kaldırılmaz. Bu çağrının sonucu, Bundle.tags öğesinin önceki etiketler kümesinin yeni etiketler kümesiyle birleşimi olmasıdır. Yinelenen etiketler yoksayılır.
Paketi Güncelleştirme

Paketi (diğer adıyla imzalayan) yeni bir e-posta, telefon numarası, ad veya kimlik doğrulama seçenekleriyle güncelleştirme

Güncelleştirilmiş paketin hala teslim edilebilir olması gerekir. Örneğin, bir deliver_via 'phone' değeri belirtirseniz, ancak özgün PacketRequest içinde ayarlanmış bir telefon numarası yoksa, bu istek bir phone de içermelidir, aksi takdirde bir hata döndürülür.

Başlangıçta ekli imzalama için yapılandırılmış bir Paketi (deliver_via 'embed' olarak) e-posta veya SMS yoluyla teslim edilecek şekilde değiştirebilirsiniz. Ancak hiçbir imzalama bildirimi veya anımsatıcı otomatik olarak gönderilmez. İmzalama bildirimi e-postası (veya SMS) göndermek için /packet/{packetId}/remind/ öğesini çağırmalısınız.

Bu İmzalayan bir Kişiyle ilişkilendirilmişse, kişi de güncelleştirilir- Kişi adı (sağlanırsa) değiştirilir ve yeni bir e-posta veya telefon numarası eklenir.
Paketi İptal Etme

Paket SümüklüBöcümü tarafından belirtilen Paketi iptal etme
Paketten Etiketleri kaldırma

Paketten etiketleri kaldırma. İstekteki bir etiket Pakette yoksayılır.
Web Kancalarını Listeleme

BlueInk hesabınızdaki tüm Web kancalarını listeleme
Web Kancası Alma

Kimliğine göre web kancası alma
Web Kancası oluşturma

Yeni web kancası oluşturma
Web Kancası Paylaşılan Gizli Diziyi Alma

Web Kancası Paylaşılan Gizli Dizisini Alma
Web Kancası Paylaşılan Gizli Diziyi Yeniden Oluşturma

Web Kancası Paylaşılan Gizli Dizisini Yeniden Oluşturma
Web Kancası Silme

Kimliğine göre Web Kancası silme
Web KancasıEvents Listele

BlueInk hesabınızdaki tüm Web Kancası Olaylarını listeleme
Web KancasıEvents Listele

BlueInk hesabınızdaki tüm WebhookDeliveries listele
Web KancasıExtraHeader'ı güncelleştirme

WebhookExtraHeader'ı yeni verilerle güncelleştirme
Web KancasıExtraHeader'ı silme

Web KancasıExtraHeader'ı silme
Web kancasıExtraHeader alma

WebhookExtraHeader'ın ayrıntılarını alma
Web KancasıExtraHeaders Listele

BlueInk hesabınızdaki tüm WebhookExtraHeaders'ı listeleme
Web Kancasını güncelleştirme

Web kancasını yeni verilerle güncelleştirin. Bu istekten atlanmış tüm aboneliklerin SİlİLECEĞINI UNUTMAYıN. Web kancası üzerindeki tüm verileri değiştirmek istemiyorsanız, bunun yerine PATCH kullanmak isteyebilirsiniz.
Web kancasını kısmen güncelleştirme

Web kancasını yeni verilerle kısmen güncelleştirin.
WebhookExtraHeader'ı kısmen güncelleştirme

WebhookExtraHeader'ı yeni verilerle kısmen güncelleştirin.
WebhookExtraHeader oluşturma

Yeni Web Kancası Üst Bilgisi oluşturma

Anımsatıcı Gönder

İşlem Kimliği:
sendPacketReminder

İmzalayana Anımsatıcı e-postası veya SMS gönderin. Anımsatıcı yalnızca saatte bir gönderilebilir. Anımsatıcı, teslim yöntemi (e-posta veya SMS) ve daha önce bu Paket için belirlenen e-posta adresine (veya telefon numarasına) gönderilir.

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 packetId True string

Paketi benzersiz olarak tanımlayan bilgi

Belge Şablonlarını Listele

İşlem Kimliği:
listTemplates

Tüm Belge Şablonlarını Listele

Döndürülenler

Name Yol Tür Description
Alanları
 fields array of

Belgeye yerleştirilen bir alan dizisi. DocumentTemplate alanlarının DocumentRequest alanlarından biraz farklı olduğunu ve yerine ve default_value değerlerinin editor_rolesinitial_value bulunduğunu editors unutmayın.
file_url
 file_url string

Bu Şablon için temel görevi görecek özgün dosyanın URL'si
is_shared
 is_shared boolean

Belge Şablonu paylaşılıyorsa True. Aksi takdirde yanlış
name
 name string

Belgenin adı. Dosya adı veya belge karşıya yüklendiğinde varsayılan olarak ayarlanır, ancak insan dostu bir ada ayarlanabilir.
roles
 roles array of object
key
 roles.key string

Bu rolü tanımlayan bu belge için benzersiz bir dize
label
 roles.label string

Bu rol için insan dostu bir etiket

Belge Şablonu Alma

İşlem Kimliği:
retrieveTemplate

Belge Şablonu Alma

Parametreler

Name Anahtar Gerekli Tür Description
Şablon Kimliği
 templateId True uuid

Şablonu benzersiz olarak tanımlayan kimlik

Döndürülenler

Name Yol Tür Description
Alanları
 fields array of

Belgeye yerleştirilen bir alan dizisi. DocumentTemplate alanlarının DocumentRequest alanlarından biraz farklı olduğunu ve yerine ve default_value değerlerinin editor_rolesinitial_value bulunduğunu editors unutmayın.
file_url
 file_url string

Bu Şablon için temel görevi görecek özgün dosyanın URL'si
is_shared
 is_shared boolean

Belge Şablonu paylaşılıyorsa True. Aksi takdirde yanlış
name
 name string

Belgenin adı. Dosya adı veya belge karşıya yüklendiğinde varsayılan olarak ayarlanır, ancak insan dostu bir ada ayarlanabilir.
roles
 roles array of object
key
 roles.key string

Bu rolü tanımlayan bu belge için benzersiz bir dize
label
 roles.label string

Bu rol için insan dostu bir etiket

Bir Kişiyi Güncelleştirme

İşlem Kimliği:
updatePerson

Kişiyi yeni verilerle güncelleştirin. Bu istekten atlanmış olan tüm kişi kanallarının SİlİLEBİLeceğini unutmayın. Kişi üzerindeki tüm verileri değiştirmek istemiyorsanız, bunun yerine PATCH kullanmak isteyebilirsiniz.

Parametreler

Name Anahtar Gerekli Tür Description
Kişi Kimliği
 personId True uuid

Kişiyi benzersiz olarak tanımlayan kimlik
e-posta
 email email
kimlik
 id uuid
tür
 kind string

e-posta için em. telefon için mp.
phone
 phone phone
kimlik
 id uuid
is_user
 is_user boolean

Bu Kişi bir BlueInk Kullanıcısı ile ilişkilendirilmişse True
metadata
 metadata object

Bu kişiyle ilişkilendirilecek meta veriler. Meta veriler SmartFill'te belgeleri otomatik olarak doldurmak için kullanılabilir. Ayrıntılar için SmartFill belgelerine bakın.
name
 name string

Kişinin adı

Döndürülenler

Name Yol Tür Description
channels
 channels array of object
e-posta
 channels.email email
kimlik
 channels.id uuid
tür
 channels.kind string

e-posta için em. telefon için mp.
phone
 channels.phone phone
kimlik
 id uuid
is_user
 is_user boolean

Bu Kişi bir BlueInk Kullanıcısı ile ilişkilendirilmişse True
metadata
 metadata object

Bu kişiyle ilişkilendirilecek meta veriler. Meta veriler SmartFill'te belgeleri otomatik olarak doldurmak için kullanılabilir. Ayrıntılar için SmartFill belgelerine bakın.
name
 name string

Kişinin adı

Bir Kişiyi kısmen güncelleştirme

İşlem Kimliği:
updatePersonPartial

Kişiyi yeni verilerle kısmen güncelleştirin.

Kişiye yeni bir e-posta veya telefon eklemek için , 'kanallar' dizisine 'id' olmadan bir ContactChannel ekleyin.

Kişiyle ilişkilendirilmiş mevcut bir ContactChannel'i güncelleştirmek için bir 'id' ekleyin. Mevcut ContactChannel yeni e-posta veya telefon ile güncelleştirilecektir. Bu işlem, söz konusu e-postaya (veya telefona) gönderen Kişiyle ilişkili tüm canlı Paketleri güncelleştirir.

ContactChannel bir 'id' içermiyorsa, ancak e-posta (veya telefon) mevcut bir ContactChannel ile eşleşiyorsa, bu ContactChannel değiştirilmez.

Parametreler

Name Anahtar Gerekli Tür Description
Kişi Kimliği
 personId True uuid

Kişiyi benzersiz olarak tanımlayan kimlik
e-posta
 email email
kimlik
 id uuid
tür
 kind string

e-posta için em. telefon için mp.
phone
 phone phone
kimlik
 id uuid
is_user
 is_user boolean

Bu Kişi bir BlueInk Kullanıcısı ile ilişkilendirilmişse True
metadata
 metadata object

Bu kişiyle ilişkilendirilecek meta veriler. Meta veriler SmartFill'te belgeleri otomatik olarak doldurmak için kullanılabilir. Ayrıntılar için SmartFill belgelerine bakın.
name
 name string

Kişinin adı

Döndürülenler

Name Yol Tür Description
channels
 channels array of object
e-posta
 channels.email email
kimlik
 channels.id uuid
tür
 channels.kind string

e-posta için em. telefon için mp.
phone
 channels.phone phone
kimlik
 id uuid
is_user
 is_user boolean

Bu Kişi bir BlueInk Kullanıcısı ile ilişkilendirilmişse True
metadata
 metadata object

Bu kişiyle ilişkilendirilecek meta veriler. Meta veriler SmartFill'te belgeleri otomatik olarak doldurmak için kullanılabilir. Ayrıntılar için SmartFill belgelerine bakın.
name
 name string

Kişinin adı

Katıştırılmış İmzalama URL'si oluşturma

İşlem Kimliği:
createPacketEmbedURL

Ekli imzalama için kullanılabilecek bir URL oluşturma

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 packetId True string

Paketi benzersiz olarak tanımlayan bilgi

Döndürülenler

Name Yol Tür Description
Sona eri -yor
 expires date-time

URL'nin süresinin ne zaman dolduğunu gösteren zaman damgası
url
 url string

Ekli imzalama için kullanılabilecek URL

Kişi Alma

İşlem Kimliği:
getPerson

Kimliğine Göre Kişi Alma

Parametreler

Name Anahtar Gerekli Tür Description
Kişi Kimliği
 personId True uuid

Kişiyi benzersiz olarak tanımlayan kimlik

Döndürülenler

Name Yol Tür Description
channels
 channels array of object
e-posta
 channels.email email
kimlik
 channels.id uuid
tür
 channels.kind string

e-posta için em. telefon için mp.
phone
 channels.phone phone
kimlik
 id uuid
is_user
 is_user boolean

Bu Kişi bir BlueInk Kullanıcısı ile ilişkilendirilmişse True
metadata
 metadata object

Bu kişiyle ilişkilendirilecek meta veriler. Meta veriler SmartFill'te belgeleri otomatik olarak doldurmak için kullanılabilir. Ayrıntılar için SmartFill belgelerine bakın.
name
 name string

Kişinin adı

Kişi Oluşturma

İşlem Kimliği:
createPerson

Yeni bir kişi oluşturun. Bir kişi bir BlueInk Kullanıcısı ile ilişkilendirilebilir veya tek başına bir kişi olabilir. BlueInk Kullanıcısı ile ilişkili bir kişi oluşturmak istiyorsanız, alanı sağlamanız user_id gerekir. Tek başına bir kişi oluşturmak istiyorsanız, alanı sağlamanız name gerekir.

Parametreler

Name Anahtar Gerekli Tür Description
e-posta
 email email
kimlik
 id uuid
tür
 kind string

e-posta için em. telefon için mp.
phone
 phone phone
kimlik
 id uuid
is_user
 is_user boolean

Bu Kişi bir BlueInk Kullanıcısı ile ilişkilendirilmişse True
metadata
 metadata object

Bu kişiyle ilişkilendirilecek meta veriler. Meta veriler SmartFill'te belgeleri otomatik olarak doldurmak için kullanılabilir. Ayrıntılar için SmartFill belgelerine bakın.
name
 name string

Kişinin adı

Döndürülenler

Name Yol Tür Description
channels
 channels array of object
e-posta
 channels.email email
kimlik
 channels.id uuid
tür
 channels.kind string

e-posta için em. telefon için mp.
phone
 channels.phone phone
kimlik
 id uuid
is_user
 is_user boolean

Bu Kişi bir BlueInk Kullanıcısı ile ilişkilendirilmişse True
metadata
 metadata object

Bu kişiyle ilişkilendirilecek meta veriler. Meta veriler SmartFill'te belgeleri otomatik olarak doldurmak için kullanılabilir. Ayrıntılar için SmartFill belgelerine bakın.
name
 name string

Kişinin adı

Kişi Silme

İşlem Kimliği:
deletePerson

Kişi Silme. Bu, ilişkili tüm BlueInk Kullanıcılarını da siler.

Parametreler

Name Anahtar Gerekli Tür Description
Kişi Kimliği
 personId True uuid

Kişiyi benzersiz olarak tanımlayan kimlik

Kişileri Listele

İşlem Kimliği:
listPersons

Hesabınızdaki Kişilerin listesini alın. İsteğe bağlı olarak bir arama sorgusu sağlayarak listeyi filtreleyebilirsiniz. Örneğin, "John" adlı tüm Kişiler'i aramak için sorgusunu search=Johnkullanabilirsiniz.

Parametreler

Name Anahtar Gerekli Tür Description
Arama Sorgusu
 search string

Arama sorgusu.

Döndürülenler

Name Yol Tür Description
array of object
channels
 channels array of object
e-posta
 channels.email email
kimlik
 channels.id uuid
tür
 channels.kind string

e-posta için em. telefon için mp.
phone
 channels.phone phone
kimlik
 id uuid
is_user
 is_user boolean

Bu Kişi bir BlueInk Kullanıcısı ile ilişkilendirilmişse True
metadata
 metadata object

Bu kişiyle ilişkilendirilecek meta veriler. Meta veriler SmartFill'te belgeleri otomatik olarak doldurmak için kullanılabilir. Ayrıntılar için SmartFill belgelerine bakın.
name
 name string

Kişinin adı

Paket Alma

İşlem Kimliği:
retrieveBundle

Sümüklüböcek tarafından paket alma

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 bundleSlug True string

Paketi benzersiz olarak tanımlayan bilgi

Paket Dosyalarını Alma

İşlem Kimliği:
getBundleFiles

Tamamlanmış bir Paket için indirilebilir dosyaları alma

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 bundleSlug True string

Paketi benzersiz olarak tanımlayan bilgi

Döndürülenler

Name Yol Tür Description
array of object
Sona eri -yor
 expires string

ISO 8601 biçimlendirilmiş bir saat olarak bağlantının süresinin dolma zamanı
file_url
 file_url string

dosyanın indirilebileceği URL

Paket Kanıt Sertifikalarını Alma

İşlem Kimliği:
getPacketCOE

Bu Paket için Kanıt Sertifikası'nın bağlantısını ve sağlama toplamını alın

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 packetId True string

Paketi benzersiz olarak tanımlayan bilgi

Paket Listele

İşlem Kimliği:
listBundles

Hesabınızdaki paketlerden oluşturulan tarihe göre (en son ve en son) sıralanmış sayfalandırılmış bir paket listesi döndürür. Sayfalama, Sayfalama paramaterleri aracılığıyla denetlenebilir (bkz. Genel Bakış-Sayfalandırma>). Sorgu dizesi filtreleri paramaterleri birleştirilebilir, örneğin. /bundles/?search=Gibbons&status__in=se,co&tag=needs-attention Filtreler bir araya getirildiğinde, yalnızca TÜM filtrelerle eşleşen Paketler döndürülür.

Parametreler

Name Anahtar Gerekli Tür Description
Arama Sorgusu
 search string

Arama sorgusu. Yalnızca aramayla eşleşen paketler döndürülür. Paketteki aşağıdaki veriler arandı:

  • paket sümüklüböcek
  • paket etiketi
  • paket custom_key
  • imzalayan adı
  • imzalayan e-postası
  • imzalayan telefonlar

Örneğin, /bundles/?search=foobar@example.com
Paket Durumu
 status string

Paketleri belirtilen duruma sahip olanlarla sınırlayın.

  • dr: Taslak - Paket henüz gönderilmedi
  • se: Gönderildi - Paket gönderildi, ancak henüz herhangi bir İmzalayan tarafından başlatılmadı
  • st: Başlatıldı - En az bir İmzalayan belgeleri gözden geçirmeye başladı
  • co: Complete - tüm İmzalayanlar gözden geçirmeyi / imzalamayı tamamladı
  • ca: İptal edildi - Paket iptal edildi
  • örn: Süresi doldu - Paketin süresi Tamamlanmadan önce doldu
  • fa: Başarısız - bir hata oluştu ve Paket oluşturulamadı veya tamamlanamadı

Örneğin, /bundles/?status=co
Paket Durumu Listesi
 status__in string

Paketleri belirtilen durumlardan birine sahip olanlarla sınırlayın. Durumlar virgülle ayrılmış olmalıdır. Örneğin, /bundles/?status=co,se,st
Paket Etiketi
 tag string

Verilen etikete sahip Paketleri döndürür. Örneğin, /bundles/?tag=some-tag
Paket Etiketleri Listesi
 tag__in string

Verilen etiketlerden en az birine sahip olan Paketleri döndürür. Etiketler virgülle ayrılmış olmalıdır. Örneğin, /bundles/?tag=some-tag,another-tag
Paket Sıralama Düzeni
 ordering string

Paket sıralama düzenini denetleme. Sıralama düzenini ters çevirmek için "-" ön eki. Varsayılan olarak, Paketler "-created" ölçütüne göre sıralanır; örneğin, Paket oluşturma tarihi en yeniden en sona kadardır.

Döndürülenler

Name Yol Tür Description
array of

Paket Olaylarını Listele

İşlem Kimliği:
listBundleEvents

Paketle ilişkili Olayların listesini alma

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 bundleSlug True string

Paketi benzersiz olarak tanımlayan bilgi

Döndürülenler

Name Yol Tür Description
array of object
açıklama
 description string

Olayın kısa bir şekilde desription
tür
 kind string

Olayın 2 karakter kodu olarak türü
packet_id
 packet_id uuid

Paketin UUID değeri. Yalnızca olay belirli bir paketle ilişkilendirildiğinde sunulur.
Tarih damgası
 timestamp date-time

Olayın gerçekleştiği saat

Paket Oluşturma

İşlem Kimliği:
createBundle

İmza için paket oluşturma ve gönderme

Parametreler

Name Anahtar Gerekli Tür Description
body
 body

Oluşturulacak Paketi tanımlayan JSON gövdesi

Paket Verilerini Alma

İşlem Kimliği:
getBundleData

Tamamlanmış bir Paket için alanlara girilen verileri alma

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 bundleSlug True string

Paketi benzersiz olarak tanımlayan bilgi

Döndürülenler

Name Yol Tür Description
array of object
attachments
 attachments array of object

Ek alanı için dosya ekleri dizisi veya null
Ext
 attachments.ext string

Dosya uzantısı
is_image
 attachments.is_image boolean

bu ek dosyası bir görüntüyse true
name
 attachments.name string

Ekin dosya adı
Num
 attachments.num integer

Dosyanın eklenme sırası, tek bir ek alanı için birden çok karşıya yükleme varsa (örneğin, web kamerasıyla çekilen bir belgenin her sayfası için bir fotoğraf)
size
 attachments.size integer

Dosyanın bayt cinsinden boyutu
url
 attachments.url url

Ek dosyasını indirmek için geçici olarak kullanılabilecek bir URL
doc_key
 doc_key string

Pakette bu belgeyi benzersiz olarak tanımlayan anahtar (özgün BundleRequest'ten)
field_key
 field_key string

Belgedeki alanı benzersiz olarak tanımlayan anahtar (BundleRequest'teki DocumentRequest'teki özgün DocumentRequestField'da belirtildiği gibi veya DocumentTemplate'da yapılandırıldığı gibi)
filled_by
 filled_by string

Bu alanın değerini giren imzalayanın Paket anahtarı. Alan değeri, imzalayan tarafından düzenlenmeyen bir 'initial_value' ise, değer 'initial' olur. Alan değeri DocumentTemplate'da yapılandırılan varsayılan değerse, dolgu 'default' olur.
tür
 kind string

Alan türü
label
 label string

Alanın etiketi (büyük olasılıkla boş)
packet_id
 packet_id

Bu alanın değerini giren imzalayanın Paket kimliği veya alan değeri bir imzalayan tarafından doldurulmadıysa null (yani, bir initial_value veya karalama değeriydi).
value
 value

Alanın değeri.

Pakete Etiket ekleme

İşlem Kimliği:
addBundleTags

Pakete ek etiketler ekleyin. Pakette mevcut etiket kaldırılmaz. Bu çağrının sonucu, Bundle.tags öğesinin önceki etiketler kümesinin yeni etiketler kümesiyle birleşimi olmasıdır. Yinelenen etiketler yoksayılır.

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 bundleSlug True string

Paketi benzersiz olarak tanımlayan bilgi
tags
 tags array of string

Bir etiket dizisi

Paketi Güncelleştirme

İşlem Kimliği:
updatePacket

Paketi (diğer adıyla imzalayan) yeni bir e-posta, telefon numarası, ad veya kimlik doğrulama seçenekleriyle güncelleştirme

Güncelleştirilmiş paketin hala teslim edilebilir olması gerekir. Örneğin, bir deliver_via 'phone' değeri belirtirseniz, ancak özgün PacketRequest içinde ayarlanmış bir telefon numarası yoksa, bu istek bir phone de içermelidir, aksi takdirde bir hata döndürülür.

Başlangıçta ekli imzalama için yapılandırılmış bir Paketi (deliver_via 'embed' olarak) e-posta veya SMS yoluyla teslim edilecek şekilde değiştirebilirsiniz. Ancak hiçbir imzalama bildirimi veya anımsatıcı otomatik olarak gönderilmez. İmzalama bildirimi e-postası (veya SMS) göndermek için /packet/{packetId}/remind/ öğesini çağırmalısınız.

Bu İmzalayan bir Kişiyle ilişkilendirilmişse, kişi de güncelleştirilir- Kişi adı (sağlanırsa) değiştirilir ve yeni bir e-posta veya telefon numarası eklenir.

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 packetId True string

Paketi benzersiz olarak tanımlayan bilgi
body
 body

Paketi İptal Etme

İşlem Kimliği:
cancelBundle

Paket SümüklüBöcümü tarafından belirtilen Paketi iptal etme

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 bundleSlug True string

Paketi benzersiz olarak tanımlayan bilgi

Paketten Etiketleri kaldırma

İşlem Kimliği:
removeBundleTags

Paketten etiketleri kaldırma. İstekteki bir etiket Pakette yoksayılır.

Parametreler

Name Anahtar Gerekli Tür Description
Paket SümüklüBöcek
 bundleSlug True string

Paketi benzersiz olarak tanımlayan bilgi
tags
 tags array of string

Bir etiket dizisi

Web Kancalarını Listeleme

İşlem Kimliği:
listWebhooks

BlueInk hesabınızdaki tüm Web kancalarını listeleme

Parametreler

Name Anahtar Gerekli Tür Description
Etkinleştirildi
 enabled boolean

Yalnızca seçili 'etkin' durumuyla eşleşen Web Kancaları döndürülür.

Örneğin, /webhooks/?enabled=true
Olay Türü
 event_type string

Yalnızca seçili event_type veya event_types eşleşen Web Kancaları döndürülür.

Örneğin, /webhooks/?event_type=bundle_sent/webhooks/?event_type__in=bundle_error,bundle_cancelled

Döndürülenler

Name Yol Tür Description
array of object
enabled
 enabled boolean
event_types
 event_types array of string

web kancasını tetikleyecek olay türleri
extra_headers
 extra_headers array of object
kimlik
 extra_headers.id uuid
name
 extra_headers.name string

RFC 7230'a uymalıdır
order
 extra_headers.order integer
value
 extra_headers.value string

RFC 7230'a uymalıdır
web kancası
 extra_headers.webhook uuid
kimlik
 id uuid
JSON
 json boolean
url
 url url

http/https de dahil olmak üzere tam URL olmalıdır

Web Kancası Alma

İşlem Kimliği:
getWebhook

Kimliğine göre web kancası alma

Parametreler

Name Anahtar Gerekli Tür Description
Web Kancası Kimliği
 webhookId True uuid

Web kancasını benzersiz olarak tanımlayan kimlik

Döndürülenler

Name Yol Tür Description
enabled
 enabled boolean
event_types
 event_types array of string

web kancasını tetikleyecek olay türleri
extra_headers
 extra_headers array of object
kimlik
 extra_headers.id uuid
name
 extra_headers.name string

RFC 7230'a uymalıdır
order
 extra_headers.order integer
value
 extra_headers.value string

RFC 7230'a uymalıdır
web kancası
 extra_headers.webhook uuid
kimlik
 id uuid
JSON
 json boolean
url
 url url

http/https de dahil olmak üzere tam URL olmalıdır

Web Kancası oluşturma

İşlem Kimliği:
createWebhook

Yeni web kancası oluşturma

Parametreler

Name Anahtar Gerekli Tür Description
enabled
 enabled boolean
event_types
 event_types array of string

web kancasını tetikleyecek olay türleri
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid
kimlik
 id uuid
JSON
 json boolean
url
 url url

http/https de dahil olmak üzere tam URL olmalıdır

Döndürülenler

Name Yol Tür Description
enabled
 enabled boolean
event_types
 event_types array of string

web kancasını tetikleyecek olay türleri
extra_headers
 extra_headers array of object
kimlik
 extra_headers.id uuid
name
 extra_headers.name string

RFC 7230'a uymalıdır
order
 extra_headers.order integer
value
 extra_headers.value string

RFC 7230'a uymalıdır
web kancası
 extra_headers.webhook uuid
kimlik
 id uuid
JSON
 json boolean
url
 url url

http/https de dahil olmak üzere tam URL olmalıdır

Web Kancası Paylaşılan Gizli Diziyi Alma

İşlem Kimliği:
getWebhookSecret

Web Kancası Paylaşılan Gizli Dizisini Alma

Döndürülenler

Name Yol Tür Description
create_date
 create_date date-time
secret
 secret b58

Web Kancası Paylaşılan Gizli Diziyi Yeniden Oluşturma

İşlem Kimliği:
regenerateWebhookSecret

Web Kancası Paylaşılan Gizli Dizisini Yeniden Oluşturma

Döndürülenler

Name Yol Tür Description
create_date
 create_date date-time
secret
 secret b58

Web Kancası Silme

İşlem Kimliği:
deleteWebhook

Kimliğine göre Web Kancası silme

Parametreler

Name Anahtar Gerekli Tür Description
Web Kancası Kimliği
 webhookId True uuid

Web kancasını benzersiz olarak tanımlayan kimlik

Web KancasıEvents Listele

İşlem Kimliği:
listWebhookEvents

BlueInk hesabınızdaki tüm Web Kancası Olaylarını listeleme

Parametreler

Name Anahtar Gerekli Tür Description
Web Kancası Kimliği
 webhook uuid

Yalnızca seçili web kancası kimliğiyle eşleşen Web KancasıEvents döndürülür.

Örneğin, /webhooks/events/?webhook=a053644f-e371-4883-ac17-534445993346
Olay Türü
 event_type string

Yalnızca seçili event_type veya event_types eşleşen web kancalarına sahip Web kancaları döndürülür.

Örneğin, /webhooks/events/?event_type=bundle_sent/webhooks/events/?event_type__in=bundle_error,bundle_cancelled
Statü
 status integer

Yalnızca seçili durumla eşleşen Web KancasıEvents döndürülür.

Örneğin, /webhooks/events/?status=1/webhooks/events/?status__in=0,1,2
Başarı Sonucu
 success boolean

Yalnızca seçili başarı durumuyla eşleşen Web kancasıEvents döndürülür.

Örneğin, /webhooks/events/?success=true
Tarih Aralığı
 date date-time

Yalnızca bir tarih aralığı arasında gerçekleşen Web KancasıEvent'ler döndürülür. Not: Tarihler YYYY-MM-DD biçimi olarak ifade edilir.

Örneğin, /webhooks/events/?date_after=2022-10-01&date_before=2022-10-31

Döndürülenler

Name Yol Tür Description
array of object
Oluşturulan
 created date-time
Teslimat
 deliveries array of object
message
 deliveries.message string

sorunları açıklayan bir ileti
Pk
 deliveries.pk uuid
statü
 deliveries.status integer

yanıtın durum iletisi veya durum yoksa 0
Tarih damgası
 deliveries.timestamp date-time

teslim girişimi gerçekleştiğinde (denemenin başlangıcı, başarısız olduğunda değil, örneğin zaman aşımı için)
event_type
 event_type string
payload
 payload string

teslimatta gönderilecek yük; json
Pk
 pk uuid
statü
 status integer

web kancası uç noktasından gelen son yanıtın durum kodu. 0 yanıt alındığını gösterir
başarı
 success boolean
web kancası
 webhook uuid

Olayın hangi web kancasına ait olduğunu tanımlayan UUID

Web KancasıEvents Listele

İşlem Kimliği:
listWebhookDeliveries

BlueInk hesabınızdaki tüm WebhookDeliveries listele

Parametreler

Name Anahtar Gerekli Tür Description
Web Kancası Kimliği
 webhook uuid

Yalnızca seçili web kancası kimliğiyle eşleşen WebhookDeliveries döndürülür.

Örneğin, /webhooks/deliveries/?webhook=a053644f-e371-4883-ac17-534445993346
Web Kancası Olay Kimliği
 webhook_event uuid

Yalnızca seçili webhook_event kimliğiyle eşleşen WebhookDeliveries döndürülür.

Örneğin, /webhooks/deliveries/?webhook_event=a053644f-e371-4883-ac17-534445993346
Olay Türü
 event_type string

Yalnızca seçili event_type veya event_types eşleşen web kancalarına sahip WebhookDeliveries döndürülür.

Örneğin, /webhooks/deliveries/?event_type=bundle_sent/webhooks/deliveries/?event_type__in=bundle_error,bundle_cancelled
Statü
 status integer

Yalnızca seçili durumla eşleşen WebhookDeliveries döndürülür.

Örneğin, /webhooks/deliveries/?status=1/webhooks/deliveries/?status__in=0,1,2
Tarih Aralığı
 date date-time

Yalnızca bir tarih aralığı arasında gerçekleşen WebhookDeliveries döndürülür. Not: Tarihler YYYY-MM-DD biçimi olarak ifade edilir.

Örneğin, /webhooks/deliveries/?date_after=2022-10-01&date_before=2022-10-31

Döndürülenler

Name Yol Tür Description
array of object
Oluşturulan
 created date-time
Teslimat
 deliveries array of object
message
 deliveries.message string

sorunları açıklayan bir ileti
Pk
 deliveries.pk uuid
statü
 deliveries.status integer

yanıtın durum iletisi veya durum yoksa 0
Tarih damgası
 deliveries.timestamp date-time

teslim girişimi gerçekleştiğinde (denemenin başlangıcı, başarısız olduğunda değil, örneğin zaman aşımı için)
event_type
 event_type string
payload
 payload string

teslimatta gönderilecek yük; json
Pk
 pk uuid
statü
 status integer

web kancası uç noktasından gelen son yanıtın durum kodu. 0 yanıt alındığını gösterir
başarı
 success boolean
web kancası
 webhook uuid

Olayın hangi web kancasına ait olduğunu tanımlayan UUID

Web KancasıExtraHeader'ı güncelleştirme

İşlem Kimliği:
updateWebhookExtraHeader

WebhookExtraHeader'ı yeni verilerle güncelleştirme

Parametreler

Name Anahtar Gerekli Tür Description
WebhookExtraHeader Kimliği
 webhookExtraHeaderId True uuid

WebhookExtraHeader'ı benzersiz olarak tanımlayan kimlik
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid

Döndürülenler

Name Yol Tür Description
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid

Web KancasıExtraHeader'ı silme

İşlem Kimliği:
deleteWebhookExtraHeader

Web KancasıExtraHeader'ı silme

Parametreler

Name Anahtar Gerekli Tür Description
WebhookExtraHeader Kimliği
 webhookExtraHeaderId True uuid

WebhookExtraHeader'ı benzersiz olarak tanımlayan kimlik

Web kancasıExtraHeader alma

İşlem Kimliği:
getWebhookExtraHeader

WebhookExtraHeader'ın ayrıntılarını alma

Parametreler

Name Anahtar Gerekli Tür Description
WebhookExtraHeader Kimliği
 webhookExtraHeaderId True uuid

WebhookExtraHeader'ı benzersiz olarak tanımlayan kimlik

Döndürülenler

Name Yol Tür Description
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid

Web KancasıExtraHeaders Listele

İşlem Kimliği:
listWebhookExtraHeaders

BlueInk hesabınızdaki tüm WebhookExtraHeaders'ı listeleme

Parametreler

Name Anahtar Gerekli Tür Description
Web Kancası Kimliği
 webhook uuid

Yalnızca seçili web kancası kimliğiyle eşleşen WebhookExtraHeaders döndürülür.

Örneğin, /webhooks/headers/?webhook=a053644f-e371-4883-ac17-534445993346
Olay Türü
 event_type string

Yalnızca seçili event_type veya event_types eşleşen web kancalarına sahip Web KancalarıExtraHeaders döndürülür.

Örneğin, /webhooks/headers/?event_type=bundle_sent/webhooks/headers/?event_type__in=bundle_error,bundle_cancelled

Döndürülenler

Name Yol Tür Description
array of object
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid

Web Kancasını güncelleştirme

İşlem Kimliği:
updateWebhook

Web kancasını yeni verilerle güncelleştirin. Bu istekten atlanmış tüm aboneliklerin SİlİLECEĞINI UNUTMAYıN. Web kancası üzerindeki tüm verileri değiştirmek istemiyorsanız, bunun yerine PATCH kullanmak isteyebilirsiniz.

Parametreler

Name Anahtar Gerekli Tür Description
Web Kancası Kimliği
 webhookId True uuid

Web kancasını benzersiz olarak tanımlayan kimlik
enabled
 enabled boolean
event_types
 event_types array of string

web kancasını tetikleyecek olay türleri
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid
kimlik
 id uuid
JSON
 json boolean
url
 url url

http/https de dahil olmak üzere tam URL olmalıdır

Döndürülenler

Name Yol Tür Description
enabled
 enabled boolean
event_types
 event_types array of string

web kancasını tetikleyecek olay türleri
extra_headers
 extra_headers array of object
kimlik
 extra_headers.id uuid
name
 extra_headers.name string

RFC 7230'a uymalıdır
order
 extra_headers.order integer
value
 extra_headers.value string

RFC 7230'a uymalıdır
web kancası
 extra_headers.webhook uuid
kimlik
 id uuid
JSON
 json boolean
url
 url url

http/https de dahil olmak üzere tam URL olmalıdır

Web kancasını kısmen güncelleştirme

İşlem Kimliği:
updateWebhookartial

Web kancasını yeni verilerle kısmen güncelleştirin.

Parametreler

Name Anahtar Gerekli Tür Description
Web Kancası Kimliği
 webhookId True uuid

Web kancasını benzersiz olarak tanımlayan kimlik
enabled
 enabled boolean
event_types
 event_types array of string

web kancasını tetikleyecek olay türleri
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid
kimlik
 id uuid
JSON
 json boolean
url
 url url

http/https de dahil olmak üzere tam URL olmalıdır

Döndürülenler

Name Yol Tür Description
enabled
 enabled boolean
event_types
 event_types array of string

web kancasını tetikleyecek olay türleri
extra_headers
 extra_headers array of object
kimlik
 extra_headers.id uuid
name
 extra_headers.name string

RFC 7230'a uymalıdır
order
 extra_headers.order integer
value
 extra_headers.value string

RFC 7230'a uymalıdır
web kancası
 extra_headers.webhook uuid
kimlik
 id uuid
JSON
 json boolean
url
 url url

http/https de dahil olmak üzere tam URL olmalıdır

WebhookExtraHeader'ı kısmen güncelleştirme

İşlem Kimliği:
updateWebhookExtraHeaderPartial

WebhookExtraHeader'ı yeni verilerle kısmen güncelleştirin.

Parametreler

Name Anahtar Gerekli Tür Description
WebhookExtraHeader Kimliği
 webhookExtraHeaderId True uuid

WebhookExtraHeader'ı benzersiz olarak tanımlayan kimlik
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid

Döndürülenler

Name Yol Tür Description
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid

WebhookExtraHeader oluşturma

İşlem Kimliği:
createWebhookExtraHeader

Yeni Web Kancası Üst Bilgisi oluşturma

Parametreler

Name Anahtar Gerekli Tür Description
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid

Döndürülenler

Name Yol Tür Description
kimlik
 id uuid
name
 name string

RFC 7230'a uymalıdır
order
 order integer
value
 value string

RFC 7230'a uymalıdır
web kancası
 webhook uuid