AçBakİmzala Entegrasyonuna Başlarken
Create Workflow
İş akışı oluşturmak için kullanılan API endpoint
İş akışı oluşturmak için kullanılan API endpoint - Kullanılacak Adres : {{KIP.Api Url}}/services/WorkflowIntegrationV2/CreateWorkflow - Metod çağrısı yapılırken,
Body:
{
"Config": {
"AppId": "AçBak-KIP AppId", // Sistem ve Entegrasyon Ayarları -> Uygulama Kimlik Ayarları -> Uygulama Kimliği [Zorunlu]
"Pass": "AçBak-KIP Pass" // Sistem ve Entegrasyon Ayarları -> Uygulama Kimlik Ayarları -> Uygulama Şifresi [Zorunlu]
},
"Workflow": {
"WorkflowStartedBy": "" // İş akışını oluşturacak kişinin Açbak-KIP kullanıcı adı [Zorunlu]
"SendNotificationMailToFirstSigner": true, //İş akışı oluşturulduktan sonra ilk imzacıya bilgilendirme maili gönderilsin mi? (true false) [Zorunlu Değil - Varsayılan Değer: false]
"AddQR": false, // İmza türü (SignType) sadece PAdES olan iş akışı için 'Karekod Ayarları' sayfasında oluşturulan karekod imzalancak belgelere eklensin mi? (true, false) [Zorunlu Değil - Varsayılan Değer: false]
"DocumentWorkflow": {
"Name": "", // İş akışı adı [Zorunlu]
"Description": "", // İş akışı açıklaması [Zorunlu Değil]
"ContractAmount": 10, // Sözleşme tutarı [Zorunlu Değil]
"Currency": 0, // Sözleşme tutarı para birimi [Zorunlu Değil - Varsayılan Değer = 0 -> TL]
"ContractStartDate": "09/07/2023", // Sözleşme başlangıç tarihi [Zorunlu Değil]
"SignType": "PAdES", // İmza türü [Zorunlu - Kabul Edilen Değerler: CAdES - PAdES - XAdES]
"SignValidationTime": "XL" // İmza Tipi [Zorunlu - Kabul Edilen Değerler: BES - EST - XL - LTV]
},
"PostOperation": {
"IsDocumentToBeArchived": true, // İş akışı tamamlandıktan sonra imzalanan belgeler arşivlensin mi? (true, false) [Zorunlu Değil - Varsayılan Değer: false]
"SendFtp": false, // İş akışı tamamlandıktan sonra imzalanan belgeler belirtilen FTP sunucusuna aktarılsın mı? (true, false) [Zorunlu Değil - Varsayılan Değer: false]
"FtpAddress": "ftp://FTP_Sunucusu_IP_Adresi/", // Sistem ve Entegrasyon Ayarları -> FTP Ayarları sayfasında kayıtlı olan FTP Sunucusunun Adresi [SendFtp Değeri true ise Zorunlu]
"SendMail": true, // İş akışı tamamlandıktan sonra imzalanan belgeler belirtilen mail adresine gönderilsin mi? (true, false) [Zorunlu Değil - Varsayılan Değer: false]
"MailAddresses": "iş akışını başlatan kişinin mail adresi", // İmzalanan belgelerin gönderileceği mail adresi [SendMail Değeri true ise Zorunlu]
"SaveToFolder": true, // İş akışı tamamlandıktan sonra imzalanan belgeler Sistem ve Entegrasyon Ayarları -> Klasör Ayarları sayfasında belirtilen 'İmzalı Dosyaların Kaydedileceği Klasör Yolu'na kaydedilsin mi? (true, false) [Zorunlu Değil - Varsayılan Değer: false]
"IsSendToAllUsersInWorkflow": true, // İş akışı tamamlandıktan sonra imzalanan belgeler belirtilen mail adreslerine gönderilsin mi? [Zorunlu Değil - Varsayılan Değer: false]
"EmailRecipients": [ // İmzalanan belgelerin gönderileceği mail adresleri [IsSendToAllUsersInWorkflow Değeri true ise Zorunlu]
"ornek1@ornek.com",
"ornek2@ornek.com",
.,
.
],
"SendToWebService": true, // İş akışı tamamlandıktan sonra imza belgeler belirtilen web servise gönderilsin mi? [Zorunlu Değil - Varsayılan Değer: false]
"WebServiceUuid": "6c23e658-9ee2-4e5d-9fab-99f3966eda5e" // İmzalanan belgelerin gönderileceği Sistem ve Entegrasyon Ayarları -> Web Servis Ayarları sayfasında bulunan Web Servis Kodu değeri [SendToWebService true ise Zorunlu]
},
"WorkflowAttributeList": [ // Sistem ve Entegrasyon Ayarları -> Form Ayarları sayfasında eklenen ek bilgi alanlar [Yönetici tarafından ek bilgi alanı oluşturulurken Zorunlu olarak seçildi ise bu alanı doldurmak Zorunlu]
{
"ParentCode": "1", // Sistem ve Entegrasyon Ayarları -> Form Ayarları sayfasında eklenen ek bilginin 'Etiket Kodu' değeri [Zorunlu]
"ChildCode": "2", // [Zorunlu Değil]
"Value": "test" // Ek bilginin alacağı değer [Zorunlu Değil]
},
{
.,
.,
.,
},
.
.
],
"WorkflowStepList": [
{
"Username": "", // İş akışına ekelencek kişinin Açbak-KIP kullanıcı adı [Kişi dış kullanıcı olarak eklenecek ise Zorunlu Değil bu alan boş bırakılmalıdır]
"Name": "", // İş akışına eklenecek kişinin adı [Zorunlu]
"Surname": "", // İş akışına eklenecek kişinin soyadı [Zorunlu]
"IDNumber": "", // // İş akışına eklenecek kişinin kimlik numarası [Zorunlu]
"EmailAddress": "", // İş akışına eklenecek kişinin mail adresi [Zorunlu]
"OrderNo": 1, // İş akışına eklenecek kişinin sıra numarası [Zorunlu]
"GroupNo": null, // İş akışına eklenecek kişinin grup numarası [GroupOrderNo değeri girilmiş ise Zorunlu]
"GroupOrderNo": null, // İş akışına eklenecek kişinin grup sıra numarası [GroupNo değeri girilmiş ise Zorunlu]
"TaskType": 4, // İş akışına eklenecek kişinin işlem tipi [Zorunlu - Kabul Edilen Değerler: Seri İmza -> 0 - Paralel İmza -> 1 - Onay -> 2 - Düzenleyici -> 3 - İzleyici -> 4 -> Mühür -> 5]
"CompletionRule": 0, // İş akışına eklenecek kişinin grup içerisindeki imza tamamlama kuralı [Zorunlu Değil - Varsayılan Değer: 0 - Kabul Edilen Değerler: Sıralı -> 0 - Sıra Bağımsız -> 1 (Kişi yalnızca grup içerisinde ise sıra bağımsız yapılabilir)]
"IsNecessary": false, // Grup içerisindeki kişinin imzalaması/onaylaması zorunlu mu? [Zorunlu Değil - Varsayılan Değer: false - Kabul Edilen Değerler: true (Kişi yalnızca grup içerinde ise değer ture yapılabilir) - false - null]
"WorkflowStepNotificationList": [ // İş akışına eklenecek kişinin alması istenen bildirim tipleri
{
"WorkflowStepNotificationType": 1 // Sistemde kayıtlı bildirim tipinin kodu [Sistemde kayıtlı tipin kodunu yazmak Zorunlu]
},
{
.
},
.
.
],
"WorflowStepPrivilegeModelList": [ // İş akışına eklenecek kişinin yetkileri
{
"WorkflowPrivilegeType": 1 // Sistemde kayıtlı yetkinin kodu [Sistemde kayıtlı yetkinin kodunu yazmak Zorunlu]
},
{
.
},
.
.
]
},
{
.,
.,
},
.
.
],
"FileList": [
{
"FileName": "sample.pdf", // İş akışına eklenecek dokümanın adı [Zorunlu]
"FileType": 1, // İş akışına eklenecek dokümanın dosya tipi [Zorunlu - Kabul Edilen Değerler: İmzalanacak Doküman -> 0 - Ek Doküman -> 1]
"Data": "" // İş akışına eklenecek dokümanın base64 data bilgisi [Zorunlu]
},
{
.,
.,
},
.
.
]
}
}
Şeklinde bir JSON Body ile gönderilerek POST isteği yapılmalıdır.Cancel Workflow
İş akışı iptal etmek için kullanılan API endpoint
İş akışı iptal etmek için kullanılan API endpoint - Kullanılacak Adres : {{KIP.Api Url}}/services/WorkflowIntegrationV2/CancelWorkflow - Metod çağrısı yapılırken,
Params:
workflowUuid : d0e7d211-e143-4a49-8f2b-2513e96494aa // İptal edilecek iş akışının workflowUuid değeri
Body:
{
"Config": {
"AppId": "AçBak-KIP AppId", // Sistem ve Entegrasyon Ayarları -> Uygulama Kimlik Ayarları -> Uygulama Kimliği [Zorunlu]
"Pass": "AçBak-KIP Pass" // Sistem ve Entegrasyon Ayarları -> Uygulama Kimlik Ayarları -> Uygulama Şifresi [Zorunlu]
},
"CancelledBy": "", // İş akışını iptal edecek kişinin Açbak-KIP kullanıcı adı [Zorunlu]
"CancellationReason": "" // İş akışı iptal sebebi [Zorunlu]
}
Şeklinde bir Parametre ve JSON Body ile gönderilerek PUT isteği yapılmalıdır.GetSignerInfos
İş akışındaki tüm kişilerin durumlarını sorgulamak için kullanılan API endpoint
İş akışındaki tüm kişilerin durumlarını sorgulamak için kullanılan API endpoint - Kullanılacak Adres : {{KIP.Api Url}}/services/WorkflowIntegrationV2/GetSignerInfos - Metod çağrısı yapılırken,
Params:
workflowUuid : d0e7d211-e143-4a49-8f2b-2513e96494aa // Sorgulanacak iş akışının workflowUuid değeri
Body:
{
"Config": {
"AppId": "AçBak-KIP AppId", // Sistem ve Entegrasyon Ayarları -> Uygulama Kimlik Ayarları -> Uygulama Kimliği [Zorunlu]
"Pass": "AçBak-KIP Pass" // Sistem ve Entegrasyon Ayarları -> Uygulama Kimlik Ayarları -> Uygulama Şifresi [Zorunlu]
}
}
Şeklinde bir Parametre ve JSON Body ile gönderilerek GET isteği yapılmalıdır.
GetStatus
İş akışındaki sıradaki kişiyi sorgulamak için kullanılan API endpoint
İş akışındaki sıradaki kişiyi sorgulamak için kullanılan API endpoint - Kullanılacak Adres : {{KIP.Api Url}}/services/WorkflowIntegrationV2/GetStatus - Metod çağrısı yapılırken,
Params:
workflowUuid : d0e7d211-e143-4a49-8f2b-2513e96494aa // Sorgulanacak iş akışının workflowUuid değeri
Body:
{
"Config": {
"AppId": "AçBak-KIP AppId", // Sistem ve Entegrasyon Ayarları -> Uygulama Kimlik Ayarları -> Uygulama Kimliği [Zorunlu]
"Pass": "AçBak-KIP Pass" // Sistem ve Entegrasyon Ayarları -> Uygulama Kimlik Ayarları -> Uygulama Şifresi [Zorunlu]
}
}
Şeklinde bir Parametre ve JSON Body ile gönderilerek GET isteği yapılmalıdır.GetSignedWorkflowFiles
Tamamlanan iş akışındaki imzalanan belgerli almak için kullanılan API endpoint
Tamamlanan iş akışındaki imzalanan belgerli almak için kullanılan API endpoint - Kullanılacak Adres : {{KIP.Api Url}}/services/WorkflowIntegrationV2/GetSignedWorkflowFiles - Metod çağrısı yapılırken,
Params:
workflowUuid : d0e7d211-e143-4a49-8f2b-2513e96494aa // Sorgulanacak iş akışının workflowUuid değeri
Body:
{
"Config": {
"AppId": "AçBak-KIP AppId", // Sistem ve Entegrasyon Ayarları -> Uygulama Kimlik Ayarları -> Uygulama Kimliği [Zorunlu]
"Pass": "AçBak-KIP Pass" // Sistem ve Entegrasyon Ayarları -> Uygulama Kimlik Ayarları -> Uygulama Şifresi [Zorunlu]
}
}
Şeklinde bir Parametre ve JSON Body ile gönderilerek GET isteği yapılmalıdır.
