Ekleme ve Güncelleme
İmza sürecinde banka SFTP sistemine dosya bırakılması gereken durumlar için, bankaya ait SFTP bilgilerinin gönderilmesi gerekmektedir. Her imza sürecinde aynı bigileri tekrar tekrar göndermek yerine,
bu api metodu ile bir alias vererek sisteme tanımlama yapabilir ve imza çağırısı esnasında sadece alias gönderimi yaparak SFTP bilgilerinizin kullanılmasını sağlayabilirsiniz.
Api Adresi:[POST] /api/actiondefinition/createorupdate
Kopyala
{
"action": "",
"alias": "",
"parameters": [
{
"key": "",
"value": ""
}
]
}
Aksiyon Ekleme ve Güncelleme İstek Modeli
Alan
Tip
Açıklama
action
enum string
Aksiyona ait enum değeridir SFTP, SFTPFILE, EMAIL ve EMAILFILE enum tiplerinden birini gönderebilirsiniz.
alias
string
Aksiyon olarak eklediğiniz tanımın alias bilgisidir. Tekil bir değer göndermelisiniz.
parameters
array
key ve value alanlarıyla yönetilen bu model ile dinamik olarak tanımı yapılan aksiyona uygun parametreler kaydedilebilir
key Host
string
Sunucu adres bilgisi
key Username
string
Sunucuda yetkili kullanıcı adı bilgisi
key Password
string
Sunucuda yetkili kullanıcı parola bilgisi
key Port
string
Port bilgisi
key DirectoryPath
string
Dosyaların bırakılacağı dizin adresi
key FileBase64
string
Sunucuya bırakılacak dokümanın base64 verisi
key FileName
string
Sunucuya bırakılacak doküman adı
key IsBodyHtml
string
Mail body html mi? true/false
key Body
string
Mail body içeriği
key Subject
string
Mail konu bilgisi
key To
string
Mail alıcı listesi ; ile ayırarak birden fazla gönderilebilir
key Cc
string
Mail kopyası alıcı listesi ; ile ayırarak birden fazla gönderilebilir
key Bcc
string
Mail gizli kopyası alıcı listesi ; ile ayırarak birden fazla gönderilebilir
key MailServer
string
Mail server host adresi bilgisidir
key MailPort
string
Mail server port bilgisidir
key SenderName
string
Mail gönderici adı bilgisidir
key Sender
string
Mail gönderici adres bilgidir
key Sender
string
Mail gönderici adres bilgidir
key UseSSL
string
Mail ssl kullanım bilgisidir. true/false
key RequiresAuthentication
string
Mail smtp doğrulaması yapılacak mı? true/false
SFTP Gönderim Örneği İlgili alanları banka bilgileri ile güncelleyerek gönderebilirsiniz.
Kopyala
{
"action": "SFTP",
"alias": "UNIQUE_HERHANGI_BIR_ALIAS",
"parameters": [
{
"Key": "Host",
"Value": "192.168.0.1"
},
{
"Key": "Username",
"Value": "DummyUsername"
},
{
"Key": "Password",
"Value": "PA$SSWRD"
},
{
"Key": "Port",
"Value": "22"
},
{
"Key": "DirectoryPath",
"Value": "/KLASOR"
}
]
}
SFTPFILE Gönderim Örneği İlgili alanları banka bilgileri ile güncelleyerek gönderebilirsiniz.
Kopyala
{
"action": "SFTPFILE",
"alias": "UNIQUE_HERHANGI_BIR_ALIAS",
"parameters": [
{
"Key": "Host",
"Value": "192.168.0.1"
},
{
"Key": "Username",
"Value": "DummyUsername"
},
{
"Key": "Password",
"Value": "PA$SSWRD"
},
{
"Key": "Port",
"Value": "22"
},
{
"Key": "DirectoryPath",
"Value": "/KLASOR"
},
{
"Key": "FileBase64",
"Value": "DOKUMANIN_BASE64_FORMATLI_HALI"
},
{
"Key": "FileName",
"Value": "dokuman_adi.txt"
}
]
}
EMAIL Gönderim Örneği İlgili alanları banka bilgileri ile güncelleyerek gönderebilirsiniz.
Kopyala
{
"action": "EMAIL",
"alias": "UNIQUE_HERHANGI_BIR_ALIAS",
"parameters": [
{
"Key": "IsBodyHtml",
"Value": "false"
},
{
"Key": "Body",
"Value": "Icerik"
},
{
"Key": "Subject",
"Value": "Baslik"
},
{
"Key": "To",
"Value": "abc@abc.com;xyz@xyz.com"
},
{
"Key": "Cc",
"Value": ""
},
{
"Key": "Bcc",
"Value": ""
},
{
"Key": "Config",
"Value": "SMTPCONFIG_TANIMI_ALIAS"
}
]
}
EMAILFILE Gönderim Örneği İlgili alanları banka bilgileri ile güncelleyerek gönderebilirsiniz.
Kopyala
{
"action": "EMAILFILE",
"alias": "UNIQUE_HERHANGI_BIR_ALIAS",
"parameters": [
{
"Key": "IsBodyHtml",
"Value": "false"
},
{
"Key": "Body",
"Value": "Icerik"
},
{
"Key": "Subject",
"Value": "Baslik"
},
{
"Key": "To",
"Value": "abc@abc.com;xyz@xyz.com"
},
{
"Key": "Cc",
"Value": ""
},
{
"Key": "Bcc",
"Value": ""
},
{
"Key": "FileBase64",
"Value": "DOKUMANIN_BASE64_FORMATLI_HALI"
},
{
"Key": "FileName",
"Value": "dokuman_adi.txt"
},
{
"Key": "Config",
"Value": "SMTPCONFIG_TANIMI_ALIAS"
}
]
}
SMTPCONFIG Gönderim Örneği İlgili alanları banka bilgileri ile güncelleyerek gönderebilirsiniz.
Kopyala
{
"action": "SMTPCONFIG",
"alias": "UNIQUE_HERHANGI_BIR_ALIAS",
"parameters": [
{
"Key": "MailServer",
"Value": "192.168.0.5"
},
{
"Key": "MailPort",
"Value": "25"
},
{
"Key": "SenderName",
"Value": "E-SIGN"
},
{
"Key": "Sender",
"Value": "info@bermuda.com.tr"
},
{
"Key": "Password",
"Value": ""
},
{
"Key": "UseSSL",
"Value": "false"
},
{
"Key": "RequiresAuthentication",
"Value": "false"
}
]
}