Dokobit Universal API

Dokobit Universal API, belgeleri dahili olarak, sisteminizde imzalamaya ve avrupa genelinde sisteminizin dışındaki 3. taraflardan imza toplamaya olanak tanıyan çok yönlü bir araçtır. Belge imzalama, kuruluşunuzun markasıyla hesapsız bir Dokobit imzalama (davet edilen katılımcıların Dokobit portalına kaydolmadan belgeleri imzaladığı) arabiriminde gerçekleşir.

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	Dokobit
URL	https://support.dokobit.com
E-posta	developers@dokobit.com

Bağlayıcı Meta Verileri
Publisher	Dokobit
Web sitesi	https://www.dokobit.com/solutions
Gizlilik ilkesi	https://www.dokobit.com/compliance/privacy-policy
Kategoriler	Verimli -lik

Dokobit Universal API, belgeleri dahili olarak, sisteminizde imzalamaya ve avrupa genelinde sisteminizin dışındaki 3. taraflardan imza toplamaya olanak tanıyan çok yönlü bir araçtır. Belge imzalama, kuruluşunuzun markasıyla hesapsız bir Dokobit imzalama (davet edilen katılımcıların Dokobit portalına kaydolmadan belgeleri imzaladığı) arabiriminde gerçekleşir.

Önkoşullar

Dokobit Evrensel API'sini kullanmak için API erişim belirtecini almak için adresinden bizimle sales@dokobit.com iletişime geçin.

Kimlik bilgilerini alma

API erişim belirtecini almak için Satışlarımızla iletişime geçin

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

• Belge imzalama işlemi 'DokobitUniversalAPICreateExternalSigning' veya 'DokobitUniversalAPICreateInternalSigning' eylemleri kullanılarak başlatılabilir. 'DokobitUniversalAPICreateExternalSigning' kullanıldığında katılımcılara bir imzalama daveti gönderilir. 'DokobitUniversalAPICreateInternalSigning' kullanıcıların yeniden yönlendirilebileceği bir imzalama URL'si oluşturur.
• daha sonra, katılımcı eklemenizi/kaldırmanızı, anımsatıcı göndermenizi veya belge imzalama durumunu denetlemenizi sağlayan ilgili eylemlerle imzalama yönetilebilir.
• Katılımcılar belgeyi imzaladıktan sonra , 'DokobitUniversalAPIDownloadDocumentExternal' veya 'DokobitUniversalAPIDownloadDocumentInternal' eylemleriyle indirilebilir.

Bilinen sorunlar ve sınırlamalar

Geçerli uygulama PDF dosyalarında imza toplamayı destekler ve ASiCe, ADoc, BDoc veya EDoc kapsayıcıları tarafından desteklenir.

Yaygın hatalar ve çözümler

• Dosya Base64 kodlanmış dosya içeriği olarak sağlanmalıdır.
• Belge imzalama 'Tür' 'pdf' olarak ayarlandıysa, belge imzalama başlatıldığında tek bir PDF belgesi kabul edilir. Birden çok dosya için imzalama 'Tür' değerini 'asice' veya başka bir kapsayıcı biçimi olarak ayarlayın.

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
API Anahtarı	securestring	Bu API için API Anahtarı	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	Yalnızca kişi henüz belgeyi imzalamamışsa katılımcı için anımsatıcı e-postası göndermeye izin verir. Yalnızca dış imzalama akışıyla çalışır.
Doğrulama - Ayrıntılı PDF Raporu	Ayrıntılı doğrulama raporunu PDF olarak indirin.
Doğrulama - PDF Raporu	Doğrulama raporunu PDF olarak indirin.
Doğrulama - XML Raporu	XML'de doğrulama raporunu indirin.
Doğrulama - XML Tanılama Verileri	XML'de tanılama verilerini indirin.
Dış Belgeyi İndir	İmzalı belgeyi indirir.
Dış İmzalama Durumunu Denetleme	İmzalama durumu olan belgenin bilgilerini döndürür.
Dış İmzalama güncelleştirme	Mevcut belge imzalama özniteliklerinin güncelleştirilmesini sağlar.
Dış İmzalama Oluşturma	Dış imzalama, sisteminizden zaman uyumsuz imzalama isteği başlatır. Bu durumda kullanıcı imzalama için bir e-posta alır ve belgeyi imzaladıktan sonra bir geri arama alırsınız.
Dış İmzalama Sil	Belge, sahibin hesabından kaldırılır. Diğer katılımcılar tarafından erişilebilir durumda kalır.
Dış İmzalayan Ekle	Belirtilen katılımcılar seçili rolle belgeye erişim kazanır.
Dış İmzalayanı Sil	Belirtilen katılımcı için belgeye erişim iptal edilir.
e-Teslim	Belge e-Teslimi, Belgeleri Dokobit Evrensel API'siyle güvenli bir şekilde paylaşmak için kullanılır.
İç Belgeyi İndir	İmzalı belgeyi indirir.
İç İmzalama Durumunu Denetleme	İmzalama durumu olan belgenin bilgilerini döndürür.
İç İmzalama güncelleştirme	Mevcut belge imzalama özniteliklerinin güncelleştirilmesini sağlar.
İç İmzalama Oluşturma	İç imzalama, sisteminizden imzalama isteğini başlatır. Bu durumda, katılımcının yeniden yönlendirilmesi gereken imzalama URL'si oluşturulur.
İç İmzalayan Ekle	Belirtilen katılımcılar seçili rolle belgeye erişim kazanır.
İç İmzalayanı Sil	Belirtilen katılımcı için belgeye erişim iptal edilir.
İç İmzayı Sil	Belge, sahibin hesabından kaldırılır. Diğer katılımcılar tarafından erişilebilir durumda kalır.
Mühür imzalama	Belge, kuruluşunuzun elektronik mührüyle birlikte mühürlenir. E-sızdırmazlık developers@dokobit.com için uygun bir sertifika almak için lütfen adresinden destek birimimize başvurun.
Validation	Dokobit, nitelikli e-imza ve e-mühür doğrulamaları için eIDAS sertifikalı bir hizmet sağlayıcısıdır. Doğrulama için imzalı bir dosyayı karşıya yüklemek için bu eylemi kullanın. Desteklenen dosya türleri: asice, asics, sce, bdoc, , edoc, pdf, xmlp7s.

Anımsatıcı Gönder

İşlem Kimliği:

DokobitUniversalAPIReminder

Yalnızca kişi henüz belgeyi imzalamamışsa katılımcı için anımsatıcı e-postası göndermeye izin verir. Yalnızca dış imzalama akışıyla çalışır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.
İmzalayan Belirteci	signer	True	string	Katılımcının belirteci.
Message	message		string	İmzalayana anımsatıcı iletisi.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.

Doğrulama - Ayrıntılı PDF Raporu

İşlem Kimliği:

DokobitUniversalAPIValidationDetailedPDFReport

Ayrıntılı doğrulama raporunu PDF olarak indirin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Doğrulama Belirteci	token	True	string	DokobitUniversalAPIValidation eyleminden alınan doğrulama belirteci.

Döndürülenler

response

object

Doğrulama - PDF Raporu

İşlem Kimliği:

DokobitUniversalAPIValidationPDFReport

Doğrulama raporunu PDF olarak indirin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Doğrulama Belirteci	token	True	string	DokobitUniversalAPIValidation eyleminden alınan doğrulama belirteci.

Döndürülenler

response

object

Doğrulama - XML Raporu

İşlem Kimliği:

DokobitUniversalAPIValidationXMLReport

XML'de doğrulama raporunu indirin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Doğrulama Belirteci	token	True	string	DokobitUniversalAPIValidation eyleminden alınan doğrulama belirteci.

Döndürülenler

response

object

Doğrulama - XML Tanılama Verileri

İşlem Kimliği:

DokobitUniversalAPIValidationXMLDiagnosticData

XML'de tanılama verilerini indirin.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Doğrulama Belirteci	token	True	string	DokobitUniversalAPIValidation eyleminden alınan doğrulama belirteci.

Döndürülenler

response

object

Dış Belgeyi İndir

İşlem Kimliği:

DokobitUniversalAPIDownloadDocumentExternal

İmzalı belgeyi indirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.

Döndürülenler

response

object

Dış İmzalama Durumunu Denetleme

İşlem Kimliği:

DokobitUniversalAPICheckExternalSigningStatus

İmzalama durumu olan belgenin bilgilerini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.

Döndürülenler

Name	Yol	Tür	Description
İmzalama Durumu	status	string	Belge imzalama durumu.
İsim	name	string	Kullanıcı için görüntülenen imzalama adı.
Türü	type	string	Belge türü.
Oluşturulma Tarihi	date_created	string	Belge imzalamanın başlatıldığı tarih.
Deadline	deadline	date-time	Belirtilen saat dilimi parçasıyla imzalama son tarihi. Örnek: 2018-11-05T13:15:30Z.
Dosya Adı	filename	string	Dosyanın adı.
Dosyalar	files	array of object
İsim	files.name	string	Dosya Adı.
URL'yi indirme	files.url	string	Dosya İndirme URL'si.
MIME Türü	files.mime_type	string	Dosya MIME Türü.
Imzalayanların	signers	array of object	Katılımcı bilgileri.
Jeton	signers.token	string	Katılımcının belirteci.
İsim	signers.first_name	string	Katılımcının adı.
Surname	signers.last_name	string	Katılımcının soyadı.
Kod	signers.code	string	Katılımcının kodu.
Country	signers.country	string	Katılımcının ülkesi.
E-posta	signers.email	string	Katılımcının e-postası.
Türü	signers.type	string	Tür.
Statü	signers.status	string	Katılımcının durumu.

Dış İmzalama güncelleştirme

İşlem Kimliği:

DokobitUniversalAPIUpdateExternalSigning

Mevcut belge imzalama özniteliklerinin güncelleştirilmesini sağlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.
Deadline	deadline		date-time	Belirtilen saat dilimi parçasıyla imzalama son tarihi. Örnek: 2018-11-05T13:15:30Z.
Sabit Son Tarih	hard_deadline		boolean	katılımcılar olarak true ayarlandıysa, ayarlandıktan deadlinesonra bu belgeyi imzalayamaz veya onaylayamaz. Varsayılan: false.
Nitelikli İmza gerektir	require_qualified_signatures		boolean	Yalnızca uygun imzalarla imzalamaya izin ver. Varsayılan: false.
Video Belirlemeye İzin Ver	allow_video_identification		boolean	Video tabanlı tanımlamayı kullanarak imzalamaya izin ver. Varsayılan: false.
Belge Kaydetmeye İzin Ver	allow_document_saving		boolean	Kullanıcının belgeyi Dokobit Portalı'na kaydetmesine ve başka eylemler yapmasına izin verin. Varsayılan: true.
İzin Verilen İmzalama Yöntemleri	allowed_signing_methods		array of string	Yalnızca belirli imzalama yöntemlerine izin verin. Kullanılabilir değerler: , , , , eparaksts_mobile, bankid_no, , bankid_se, audkenni_app, ftn, electronic_iditsmesms_otpswisscomidinmitid, . smartcardsmartidmobile

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.

Dış İmzalama Oluşturma

İşlem Kimliği:

DokobitUniversalAPICreateExternalSigning

Dış imzalama, sisteminizden zaman uyumsuz imzalama isteği başlatır. Bu durumda kullanıcı imzalama için bir e-posta alır ve belgeyi imzaladıktan sonra bir geri arama alırsınız.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Türü	type	True	string	Belge biçimi. Kullanılabilir değerler: pdf, asice, bdoc, edoc, , adoc. adoc.cedoc
İsim	name	True	string	Kullanıcı için görüntülenen imzalama adı.
Geri gönderme URL'si	postback_url		string	Web kancalarını işlemek için sisteminizin URL'si.
Deadline	deadline		date-time	Belirtilen saat dilimi parçasıyla imzalama son tarihi. Örnek: 2018-11-05T13:15:30Z.
Sabit Son Tarih	hard_deadline		boolean	katılımcılar olarak true ayarlanırsa, ayarlandıktan deadlinesonra bu belgeyi imzalayamazlar. Varsayılan: false.
Nitelikli İmza gerektir	require_qualified_signatures		boolean	Yalnızca uygun imzalarla imzalamaya izin ver. Varsayılan: false.
Ek Açıklama Konumu	annotation_position		string	PDF belgesinde imza ek açıklamalarının konumunu seçebilirsiniz. Kullanılabilir değerler: first_top, first_bottom, last_top, last_bottom, none. Varsayılan: first_top.
Ek Açıklama Kişisel Kodu	annotation_personal_code		boolean	Kişisel kod olarak true ayarlanırsa ek açıklama görünür. Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: false.
Comment	comment		string	Katılımcılar için ileti.
Video Belirlemeye İzin Ver	allow_video_identification		boolean	Video tabanlı tanımlamayı kullanarak imzalamaya izin ver. Varsayılan: false.
Belge Kaydetmeye İzin Ver	allow_document_saving		boolean	Kullanıcının belgeyi Dokobit Portalı'na kaydetmesine ve başka eylemler yapmasına izin verin. Varsayılan: true.
PDF'i Düzleştirme	flatten_pdf		boolean	True olarak ayarlanırsa, form alanlarının belge içeriğinin bir parçası olması ve imzalandıktan sonra düzenlenememesi için belge düzleşir. Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: false.
İzin Verilen İmzalama Yöntemleri	allowed_signing_methods		array of string	Yalnızca belirli imzalama yöntemlerine izin verin. Kullanılabilir değerler: , , , , eparaksts_mobile, bankid_no, , bankid_se, audkenni_app, ftn, electronic_iditsmesms_otpswisscomidinmitid, . smartcardsmartidmobile
İsim	name	True	string	Dosya adı.
Content	content	True	string	Base64 kodlanmış dosya içeriği.
Dış Kimlik	external_id	True	string	Sisteminizdeki katılımcının benzersiz rastgele tanımlayıcısı. Yoksa benzersiz rastgele tanımlayıcılar oluşturabilirsiniz.
İsim	name		string	Katılımcının adı.
Surname	surname		string	Katılımcının soyadı.
E-posta	email		string	Katılımcının e-postası.
Kod	code		string	Katılımcının kişisel kodu (Ulusal Kimlik numarası).
Ülke Kodu	country_code		string	Katılımcının ülke kodu. Kişisel kod sağlanmışsa gereklidir. Kullanılabilir değerler: , , , , , NO, FI, BE, SE. ISEELVLT
Rol	role		string	Katılımcının rolü. Kullanılabilir değerler: signer, viewer. Varsayılan: signer.
Şirket	company		string	Katılımcının şirket adı.
Position	position		string	Katılımcının konumu.
Telefon	phone		string	Katılımcının telefon numarası.
Sıra	sequence		integer	Belge onaylama ve imzalama eylemlerinin sıra sırasının ayarlanmasına izin verir.
Bildirim Dili	notifications_language		string	Bildirimlerin dilini ayarlar. Kullanılabilir değerler: , , , , et, is, no, , sedenldkfifr, . lvlten
Özel Neden	custom_reason		string	Özel imza nedeni.
Sayfa	page		string	Görünür PDF imzası ek açıklaması için sayfa dizini. Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Üstten Konum	top		string	Görünür PDF imzası ek açıklaması için üstten konumu (nokta olarak). Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Soldan Konum	left		string	Görünür PDF imzası ek açıklaması için soldan konum (nokta olarak). Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Language	language		string	Görünür PDF imza ek açıklamasının dili. Yalnızca PDF türü imzalama için geçerlidir. Kullanılabilir değerler: en, lt, lv, et, is

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.
İmzalama Belirteci	token	string	İmzalama belirteci.
Imzalayanların	signers	array of object	Katılımcı bilgileri.
Dış Kimlik	signers.external_id	string	Sisteminizdeki katılımcının benzersiz rastgele tanımlayıcısı.
Jeton	signers.token	string	Katılımcının belirteci.
İsim	signers.first_name	string	Katılımcının adı.
Surname	signers.last_name	string	Katılımcının soyadı.
Kod	signers.code	string	Katılımcının kişisel kodu (Ulusal Kimlik numarası).
Country	signers.country	string	Katılımcının ülkesi.
E-posta	signers.email	string	Katılımcının e-postası.

Dış İmzalama Sil

İşlem Kimliği:

DokobitUniversalAPIDeleteExternalSigning

Belge, sahibin hesabından kaldırılır. Diğer katılımcılar tarafından erişilebilir durumda kalır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.

Dış İmzalayan Ekle

İşlem Kimliği:

DokobitUniversalAPIAddExternalSigner

Belirtilen katılımcılar seçili rolle belgeye erişim kazanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.
Dış Kimlik	external_id	True	string	Sisteminizdeki katılımcının benzersiz rastgele tanımlayıcısı. Yoksa benzersiz rastgele tanımlayıcılar oluşturabilirsiniz.
İsim	name		string	Katılımcının adı.
Surname	surname		string	Katılımcının soyadı.
E-posta	email		string	Katılımcının e-postası.
Kod	code		string	Katılımcının kodu.
Ülke kodu	country_code		string	Katılımcının ülke kodu. Kişisel kod sağlanmışsa gereklidir. Kullanılabilir değerler: , , , , , NO, FI, BE, SE. ISEELVLT
Rol	role		string	Katılımcının rolü. Kullanılabilir değerler: signer, viewer. Varsayılan: signer.
Şirket	company		string	Katılımcının şirketi.
Position	position		string	Katılımcının konumu.
Telefon	phone		string	Katılımcının telefonu.
Özel Neden	custom_reason		string	Özel imza nedeni.
Bildirim Dili	notifications_language		string	Bildirimlerin dilini ayarlar. Kullanılabilir değerler: , , , , et, is, no, , sedenldkfifr, . lvlten
Sayfa	page		string	Görünür PDF imzası ek açıklaması için sayfa dizini. Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Üstten Konum	top		string	Görünür PDF imzası ek açıklaması için üstten konumu (nokta olarak). Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Soldan Konum	left		string	Görünür PDF imzası ek açıklaması için soldan konum (nokta olarak). Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Language	language		string	Görünür PDF imza ek açıklamasının dili. Yalnızca PDF türü imzalama için geçerlidir. Kullanılabilir değerler: en, lt, lv, et, is
Comment	comment		string	Katılımcılar için ileti.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.
Imzalayanların	signers	array of object	Katılımcı bilgileri.
Dış Kimlik	signers.external_id	string	Sisteminizdeki katılımcının benzersiz rastgele tanımlayıcısı.
Jeton	signers.token	string	Katılımcının belirteci.
İsim	signers.name	string	Katılımcının adı.
Surname	signers.surname	string	Katılımcının soyadı.
E-posta	signers.email	string	Katılımcının e-postası.
Kod	signers.code	string	Katılımcının kişisel kodu (Ulusal Kimlik numarası).
Ülke Kodu	signers.country_code	string	Katılımcının ülkesi.
Rol	signers.role	string	Katılımcının rolü.
Şirket	signers.company	string	Katılımcının şirketi.
Position	signers.position	string	Katılımcının konumu.
Bildirim Dili	signers.notifications_language	string	Bildirimlerin dilini ayarlar. Kullanılabilir değerler: en, lt, lv, , et, is, , no, 'fr', 'se', 'de'.
Telefon	signers.phone	string	Katılımcının telefonu.

Dış İmzalayanı Sil

İşlem Kimliği:

DokobitUniversalAPIDeleteExternalSigner

Belirtilen katılımcı için belgeye erişim iptal edilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.
Jeton	token	True	string	Katılımcının belirteci.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.

e-Teslim

İşlem Kimliği:

DokobitUniversalAPIeDelivery

Belge e-Teslimi, Belgeleri Dokobit Evrensel API'siyle güvenli bir şekilde paylaşmak için kullanılır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Türü	type	True	string	Belge biçimi. Kullanılabilir değerler: pdf.
İsim	name	True	string	Kullanıcı için görüntülenen belge adı.
Geri gönderme URL'si	postback_url		string	Web kancalarını işlemek için sisteminizin URL'si.
Comment	comment		string	Alıcılar için ileti.
İsim	name	True	string	Dosya adı.
Content	content	True	string	Base64 kodlanmış dosya içeriği.
Dış Kimlik	external_id	True	string	Sisteminizdeki katılımcının benzersiz rastgele tanımlayıcısı. Yoksa benzersiz rastgele tanımlayıcılar oluşturabilirsiniz.
Kod	code	True	string	Alıcının kişisel kodu (Ulusal Kimlik numarası).
Ülke Kodu	country_code	True	string	Alıcının ülke kodu. Kişisel kod sağlanmışsa gereklidir. Kullanılabilir değerler: lt, lv, ee, is.
E-posta	email		string	Belge göndermek için alıcının e-posta adresi. Telefon ayarlanmadıysa gereklidir.
Telefon	phone		string	Belge SMS'i göndermek için alıcının telefon numarası. E-posta ayarlanmadıysa gereklidir. SMS yalnızca e-posta sağlanmadığında gönderilir.
Bildirim Dili	notifications_language		string	Bildirimlerin dilini ayarlar. Kullanılabilir değerler: en, lt, lv, , et, is, , no, 'fr', 'se', 'de'.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.
Belge belirteci	token	string	Belge belirteci.
Alıcı	recipients	array of object	Alıcının bilgileri.
Dış Kimlik	recipients.external_id	string	Sisteminizdeki katılımcının benzersiz rastgele tanımlayıcısı.
Jeton	recipients.token	string	Alıcının belirteci.
Kod	recipients.code	string	Alıcının kişisel kodu (Ulusal Kimlik numarası).
Country	recipients.country	string	Alıcının ülkesi.
E-posta	recipients.email	string	Alıcının e-postası.

İç Belgeyi İndir

İşlem Kimliği:

DokobitUniversalAPIDownloadDocumentInternal

İmzalı belgeyi indirir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.

Döndürülenler

response

object

İç İmzalama Durumunu Denetleme

İşlem Kimliği:

DokobitUniversalAPICheckInternalSigningStatus

İmzalama durumu olan belgenin bilgilerini döndürür.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.

Döndürülenler

Name	Yol	Tür	Description
İmzalama Durumu	status	string	Belge imzalama durumu.
İsim	name	string	Kullanıcı için görüntülenen imzalama adı.
Türü	type	string	Belge Türü.
Oluşturulma Tarihi	date_created	string	Belge imzalamanın başlatıldığı tarih.
Deadline	deadline	date-time	Belirtilen saat dilimi parçasıyla imzalama son tarihi. Örnek: 2018-11-05T13:15:30Z.
Dosya Adı	filename	string	Dosyanın adı.
Dosyalar	files	array of object
İsim	files.name	string	Dosya Adı.
URL'yi indirme	files.url	string	Dosya İndirme URL'si.
MIME Türü	files.mime_type	string	Dosya MIME Türü.
Imzalayanların	signers	array of object	Katılımcı bilgileri.
Jeton	signers.token	string	Katılımcının belirteci.
İsim	signers.first_name	string	Katılımcının adı.
Surname	signers.last_name	string	Katılımcının soyadı.
Kod	signers.code	string	Katılımcının kodu.
Country	signers.country	string	Katılımcının ülkesi.
E-posta	signers.email	string	Katılımcının e-postası.
Türü	signers.type	string	Tür.
Statü	signers.status	string	Katılımcının durumu.

İç İmzalama güncelleştirme

İşlem Kimliği:

DokobitUniversalAPIUpdateInternalSigning

Mevcut belge imzalama özniteliklerinin güncelleştirilmesini sağlar.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.
Nitelikli İmza gerektir	require_qualified_signatures		boolean	Yalnızca uygun imzalarla imzalamaya izin ver. Varsayılan: false.
Video Belirlemeye İzin Ver	allow_video_identification		boolean	Video tabanlı tanımlamayı kullanarak imzalamaya izin ver. Varsayılan: false.
İzin Verilen İmzalama Yöntemleri	allowed_signing_methods		array of string	Yalnızca belirli imzalama yöntemlerine izin verin. Kullanılabilir değerler: , , , , eparaksts_mobile, bankid_no, , bankid_se, audkenni_app, ftn, electronic_iditsmesms_otpswisscomidinmitid, . smartcardsmartidmobile

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.

İç İmzalama Oluşturma

İşlem Kimliği:

DokobitUniversalAPICreateInternalSigning

İç imzalama, sisteminizden imzalama isteğini başlatır. Bu durumda, katılımcının yeniden yönlendirilmesi gereken imzalama URL'si oluşturulur.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
Türü	type	True	string	Belge biçimi. Kullanılabilir değerler: pdf, asice, bdoc, edoc, , adoc. adoc.cedoc
İsim	name	True	string	Kullanıcı için görüntülenen imzalama adı.
Yeniden yönlendirme URI'si	redirect_uri	True	string	İmzalama tamamlandıktan sonra imzalayanı yeniden yönlendirmek için kullanılacak yeniden yönlendirme uri'si.
Geri gönderme URL'si	postback_url		string	Web kancalarını işlemek için sisteminizin URL'si.
Nitelikli İmza gerektir	require_qualified_signatures		boolean	Yalnızca uygun imzalarla imzalamaya izin ver. Varsayılan: false.
Ek Açıklama Konumu	annotation_position		string	PDF belgesinde imza ek açıklamalarının konumunu seçebilirsiniz. Kullanılabilir değerler: first_top, first_bottom, last_top, last_bottom, none. Varsayılan: first_top.
Ek Açıklama Kişisel Kodu	annotation_personal_code		boolean	Kişisel kod olarak true ayarlanırsa ek açıklama görünür. Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: false.
Video Belirlemeye İzin Ver	allow_video_identification		boolean	Video tabanlı tanımlamayı kullanarak imzalamaya izin ver. Varsayılan: false.
PDF'i Düzleştirme	flatten_pdf		boolean	True olarak ayarlanırsa, form alanlarının belge içeriğinin bir parçası olması ve imzalandıktan sonra düzenlenememesi için belge düzleşir. Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: false.
İzin Verilen İmzalama Yöntemleri	allowed_signing_methods		array of string	Yalnızca belirli imzalama yöntemlerine izin verin. Kullanılabilir değerler: , , , , eparaksts_mobile, bankid_no, , bankid_se, audkenni_app, ftn, electronic_iditsmesms_otpswisscomidinmitid, . smartcardsmartidmobile
İsim	name	True	string	Dosya adı.
Content	content	True	string	Base64 kodlanmış dosya içeriği.
Dış Kimlik	external_id	True	string	Sisteminizdeki katılımcının benzersiz rastgele tanımlayıcısı. Yoksa benzersiz rastgele tanımlayıcılar oluşturabilirsiniz.
Rol	role		string	Katılımcının rolü. Kullanılabilir değerler: signer, viewer. Varsayılan: signer.
Kod	code		string	Katılımcının kodu.
Ülke kodu	country_code		string	Katılımcının ülke kodu. Kişisel kod sağlanmışsa gereklidir. Kullanılabilir değerler: , , , , , NO, PL, FI, BESE. ISEELVLT
Telefon	phone		string	Katılımcının telefonu.
Bildirim Dili	language		string	Kullanıcı arabirimi dilini ayarlar. Kullanılabilir değerler: , , , , et, is, no, , sedenldkfifr, . lvlten
Sayfa	page		string	Görünür PDF imzası ek açıklaması için sayfa dizini. Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Üstten Konum	top		string	Görünür PDF imzası ek açıklaması için üstten konumu (nokta olarak). Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Soldan Konum	left		string	Görünür PDF imzası ek açıklaması için soldan konum (nokta olarak). Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Language	language		string	Görünür PDF imza ek açıklamasının dili. Yalnızca PDF türü imzalama için geçerlidir. Kullanılabilir değerler: en, lt, lv, et, is
Özel Neden	custom_reason		string	Özel imza nedeni.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.
İmzalama Belirteci	token	string	İmzalama belirteci.
Imzalayanların	signers	array of object	Katılımcı bilgileri.
Dış Kimlik	signers.external_id	string	Sisteminizdeki katılımcının benzersiz rastgele tanımlayıcısı.
Jeton	signers.token	string	Katılımcının belirteci.
Yeniden yönlendirme URI'si	signers.redirect_uri	string	İmzalama URL'si.

İç İmzalayan Ekle

İşlem Kimliği:

DokobitUniversalAPIAddInternalSigner

Belirtilen katılımcılar seçili rolle belgeye erişim kazanır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.
Dış Kimlik	external_id	True	string	Sisteminizdeki katılımcının benzersiz rastgele tanımlayıcısı. Yoksa benzersiz rastgele tanımlayıcılar oluşturabilirsiniz.
Rol	role		string	Katılımcının rolü. Kullanılabilir değerler: signer, viewer. Varsayılan: signer.
Kod	code		string	Katılımcının kodu.
Ülke kodu	country_code		string	Katılımcının ülke kodu. Kişisel kod sağlanmışsa gereklidir. Kullanılabilir değerler: , , , , , NO, PL, FI, BESE. ISEELVLT
Telefon	phone		string	Katılımcının telefonu.
Bildirim Dili	language		string	Kullanıcı arabirimi dilini ayarlar. Kullanılabilir değerler: , , , , et, is, no, , sedenldkfifr, . lvlten
Sayfa	page		string	Görünür PDF imzası ek açıklaması için sayfa dizini. Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Üstten Konum	top		string	Görünür PDF imzası ek açıklaması için üstten konumu (nokta olarak). Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Soldan Konum	left		string	Görünür PDF imzası ek açıklaması için soldan konum (nokta olarak). Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Language	language		string	Görünür PDF imza ek açıklamasının dili. Yalnızca PDF türü imzalama için geçerlidir. Kullanılabilir değerler: en, lt, lv, et, is
Özel Neden	custom_reason		string	Özel imza nedeni.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.
Imzalayanların	signers	array of object	Katılımcı bilgileri.
Dış Kimlik	signers.external_id	string	Sisteminizdeki katılımcının benzersiz rastgele tanımlayıcısı.
Jeton	signers.token	string	Katılımcının belirteci.
İsim	signers.name	string	Katılımcının adı.
Surname	signers.surname	string	Katılımcının soyadı.
E-posta	signers.email	string	Katılımcının e-postası.
Kod	signers.code	string	Katılımcının kişisel kodu (Ulusal Kimlik numarası).
Ülke Kodu	signers.country_code	string	Katılımcının ülkesi.
Rol	signers.role	string	Katılımcının rolü.
Şirket	signers.company	string	Katılımcının şirketi.
Position	signers.position	string	Katılımcının konumu.
Telefon	signers.phone	string	Katılımcının telefonu.

İç İmzalayanı Sil

İşlem Kimliği:

DokobitUniversalAPIDeleteInternalSigner

Belirtilen katılımcı için belgeye erişim iptal edilir.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.
Jeton	token	True	string	Katılımcının belirteci.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.

İç İmzayı Sil

İşlem Kimliği:

DokobitUniversalAPIDeleteInternalSigning

Belge, sahibin hesabından kaldırılır. Diğer katılımcılar tarafından erişilebilir durumda kalır.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.

Mühür imzalama

İşlem Kimliği:

DokobitUniversalAPISealSigning

Belge, kuruluşunuzun elektronik mührüyle birlikte mühürlenir. E-sızdırmazlık developers@dokobit.com için uygun bir sertifika almak için lütfen adresinden destek birimimize başvurun.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İmzalama Belirteci	token	True	string	İmzalama belirteci.
Özel Neden	custom_reason		string	Özel imza nedeni.
Sayfa	page		string	Görünür PDF imzası ek açıklaması için sayfa dizini. Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Üstten Konum	top		string	Görünür PDF imzası ek açıklaması için üstten konumu (nokta olarak). Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.
Soldan Konum	left		string	Görünür PDF imzası ek açıklaması için soldan konum (nokta olarak). Yalnızca PDF türü imzalama için geçerlidir. Varsayılan: 1.

Döndürülenler

Name	Yol	Tür	Description
Statü	status	string	Durum.

Validation

İşlem Kimliği:

DokobitUniversalAPIValidation

Dokobit, nitelikli e-imza ve e-mühür doğrulamaları için eIDAS sertifikalı bir hizmet sağlayıcısıdır. Doğrulama için imzalı bir dosyayı karşıya yüklemek için bu eylemi kullanın. Desteklenen dosya türleri: asice, asics, sce, bdoc, , edoc, pdf, xmlp7s.

Parametreler

Name	Anahtar	Gerekli	Tür	Description
İsim	name	True	string	Dosya adı.
Content	content	True	string	Base64 kodlanmış dosya içeriği.

Döndürülenler

Name	Yol	Tür	Description
Karşıya Yükleme Durumu	status	string	Karşıya yükleme durumu.
Doğrulama Belirteci	token	string	Doğrulama belirteci.

Tanımlar

object

Bu , 'object' türüdür.