İmza Akışı Başlatma

İmza akışı başlatmak için kullanılması gereken api metodudur. Bu metoda göndeceğiniz parametreler ile süreci yönetebilirsiniz.

Api Adresi:[POST] /api/signflow

[
  {
    "instructionNo": "string",
    "documentBase64": "string",
    "type": "string",
    "date": "string",
    "aggregateAmount": 0,
    "currency": "string",
    "targetLocation": "string",
    "instructionDetail": "string",
    "vkn": "string",
    "useTimeStamp": true,
    "timeout": 0,
    "attachDocument": true,
    "signatureFormat": "string",
    "mailType": 0,
    "language": 0,
	"CreatedBy": "string",
    "MailExplanation": "string",
    "SendFirstApproverWhenApprove": false,
    "CompanyName": "string",
    "MailBodyHtml": "string",
    "SendSmsToApprovers": false,
    "SeparatelyApprover": false,
    "PreviewDocumentInMail": false,
    "approvers": [
      {
        "name": "string",
        "surname": "string",
        "phone": "string",
        "mail": "string",
        "order": 0,
        "vkn": "string",
        "operator": "string",
        "isMobile": true,
        "signatureInfoText": "string",
        "language": "tr",
        "SignatureType": "string"
      }
    ],
    "actions": [
      {
        "action": 0,
        "alias": "string",
        "parameters": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    ],
    "stamp": {
      "useDefault": true,
      "enableQRCode": true,
      "enableText": true,
      "line1": "string",
      "line2": "string",
      "line3": "string",
      "textPositionX": 0,
      "textPositionY": 0,
      "qrCodePositionX": 0,
      "qrCodePositionY": 0,
      "qrCodeHeight": 0,
      "qrCodeWidth": 0,
      "rotationDegree": 0,
      "showUrl": true
    }
  }
]

Gönderim Testti İstek Modeli
Alan	Tip	Açıklama
instructionNo	string	Talimata ait tekil bir numara beklenmektedir. Benzersiz bir değer olmalıdır. Aynı talimat numarası birden fazla kez gönderilirse bir önceki süreç pasife çekilir.
documentBase64	string	Dokümana ait base64 verisidir
type	string	Bu alanda isteğin türünü gönderebilirsiniz. Örneğin; TEMINAT MEKTUBU/ KIYMETLİ EVRAKIN İPTALİ
date	string	İşleme ait tarih bilgisini dd.MM.yyyy formatında text olarak gönderebilirsiniz
aggregateAmount	decimal	Dokümana ait toplam tutar bilgisini bu alanda decimal formatında gönderebilirsiniz
currency	string	Para birimini bu alanda gönderebilirsiniz. TRY/USD vb.
instructionDetail	string	Talimata ilişkin detay bilgisini burada gönderebilirsiniz.
useTimeStamp	bool	Zaman damgası kullanılacak mı? Zaman damgası belgenin imzalanma zamanını garanti eden bir çeşit damga türüdür.
timeout	int	Saniye cinsinden belgenin ne kadar süre sonra zaman aşımına uğrayacağı bilgisi, süre dolduğunda belgenin durumu zaman aşımı olarak güncellenir.
attachDocument	bool	Doküman ek olarak gönderilsin mi?
signatureFormat	string	Doküman format bilgisidir. CADES/XADES/PADES
mailType	string enum	Mail türü olarak SOZLESME/ODEME/IPTAL/UPLOAD seçeneklerinden uygun olanı gönderebilirsiniz.
language	string enum	Sürecin devam edeceği dil parametresinidir. tr/en olarak gönderebilirsiniz.
CreatedBy	string	Süreci oluşturan kişi
MailExplanation	string	Sürec mailinde gönderilecek açıklama metni
SendFirstApproverWhenApprove	boolean	İlk onaycı onayladıktan sonra banka gönderimi yapılması flagı
CompanyName	string	Sürecin hangi şirket için başlatıldığı bilgisi
MailBodyHtml	string	Mail içeriğine özelleştirilmiş html eklenmesi
SendSmsToApprovers	boolean	Süreç onaycılarına sms gönderimi
SeparatelyApprover	boolean	Onaycıların sırasız onaylaması durumu
PreviewDocumentInMail	boolean	Dokümanın mail içeriğine resim olarak eklenmesi
approvers	array	Onaycılara ilişkin bilgileri bu dizi içerisinde gönderebilirsiniz
name	string	Onaycı adı
surname	string	Onaycı soyadı
phone	string	Onaycıya ait telefon numarası
mail	string	Onaycıya ait mail adresi
order	int	Onaylama sıra bilgisidir
vkn	string	Onaycıya ait vkn bilgisidir
operator	string	Onaycıya ait telefonun operator bilgisidir. TURKCELL/VODAFONE/TURKTELEKOM
signatureInfoText	string	İmza bilgi metni bilgidir
language	int	Onaycıya ait dil parametresi tr/en gönderilebilir
signatureType	int	İmzacı tipi SignatureType(Mobil İmza),ESignature(E-İmza),MobileWithESignature(Mobil İmza & E-İmza),Initial(Talep Onay)
actions	array	İmza sürecine dahil edilecek olan aksiyon tanımlarıdır
action	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.
stamp	model	İmza ile ilgili bilgi ve QR kod yönetimini bu alanda göndereceğiniz parametreler ile kontrol edebilisiniz.
useDefault	bool	Varsayılan ayarlar kullanılsın mı?
enableQRCode	bool	QR kod üretilsin mi?
enableText	bool	Text olarak bilgi verilsin mi?
line1	string	1. satırda yazacak bilgi
line2	string	2. satırda yazacak bilgi
line3	string	3. satırda yazacak bilgi
textPositionX	int	Text alanın x pozisyonu
textPositionY	int	Text alanın y pozisyonu
qrCodePositionX	int	QR bilgisinin x pozisyonu
qrCodePositionY	int	QR bilgisinin y pozisyonu
qrCodeHeight	int	QR bilgisinin yükseklik bilgisi
qrCodeWidth	int	QR bilgisinin genişlik bilgisi
rotationDegree	int	QR kod görseline ait derece açısı bilgisidir
showUrl	bool	Url bilgisi gösterilsin mi?