Etikimza Entegrasyonuna Başlarken
Etikimza e-imza ve mobil imza API’si ile 5070 sayılı e-imza kanununa uygun olarak yasal zaman damgası içeren belge imzalamayı sağlayacak tüm uygulamaların ihtiyacına cevap verecek şekilde, oturum bilgisi tutmayan (stateless) Restful servis odaklı bir mimaride geliştirilmiştir. Başlamak için aşağıdaki adımları izleyebilirsiniz.
Mobil İmza Desteği
Türkiye'de mobil imza hizmeti veren tüm GSM operatörleri ile tam uyumlu mobil imza desteği. (Turkcell, Vodafone ve Turk Telekom)
İmza Süreçleri
Sıralı ve paralel olacak şekilde detaylı olarak e-imza, mobil imza ve dijital imza süreçleri oluşturulabilir.
Dağıtım Kanalları
İmza süreci tamamlandıktan sonra E-Posta, FTP, SFTP, Google Drive, Yandex Drive, DropBox gibi kanallara dağıtım olarak sağlanır.
Yasal Zaman Damgası
Türkiye'de geçerli tüm elektronik sertifika hizmet sağlayıcı firmlarından yasal zaman damgası desteği.
Tarayıcı Bağımsız
MacOS (safari, chrome, firefox, opera)
Windows (chrome, firefox, opera) tarayıcılarında eklenti desteği bulunmaktadır.
Hızlı İmzalama
Yüksek sayıda dosyalara aynı anda ve hızlı bir şekilde ayrık imza atabilme desteği.
Bağlantı istek adresi
Yapılan tüm istekler aşağıda belirtilen adrese iletilmelidir.
https://belge.etikimza.com/api/Kimlik Doğrulama
Method : POST
ContentType : application/json
Url : Auth
Request :
{
uid:string
Pwd:string
}
Request Sample:
{
uid:"luffy@leafinbox.com",
pwd:"123456"
}
Response:
{
StatusText:String,
StatusCode:int,
AuthToken:string
ExpireAt:Date
IsAuthenticated:bool
}
Kimlik Doğrulama - Örnek Cevap
{"AuthToken":"UGa8aKasasmLqBpw2k1is0GK2499NI8kY546kQVWNQ3NIBVW","ExpireAt":"2019-10-21T17:01:45.699682Z","ExpireIn":21600,"IsAuthenticated":true,"StatusText":"Success","StatusCode":0,"Status":0}
Doküman Yükleme
Method : POST
ContentType : multipart/form-data
Header : Authorization:(AuthToken)
: Content-Disposition:attachment;name=FileKey_Value;filename= FileName;
OR
: Content-Disposition:attachment;name=file;filename=FileName;filekey=FileKey_Value
Url :startfile
Response:
{
StatusText:String,
StatusCode:int,
Files:[
{
FileName:string
FileKey:string,
TempName:string
}
]
}
Not: Birden çok dosya yüklemelerinde dosya ayrıştırmanız gerekiyorsa FileKey gereklidir.
(1000 dosya yükleyip birini silmeniz gereken durumlarda hangi dosya olduğunu FileKey ile belirtmeniz gerekir.)
Süreç Başlatma
Method : POST
ContentType : application/json
Url : start
Header : Authorization:(AuthToken)
Request :
{
EntegrationKey:string
UseTimeStamp:bool(Optional)
Subject:string
SubjectDetail:string
ParallelSignature:bool
SignatureType:string (“PadES” or ”CadES”)
Signers:[
{
Index:String(optional)
FullName:string
EMail:string
SignType:string(“eSign” or ”digitalSignature”)
Step:int(optional)
AlternativeIndex:String(optional)
SignatureText:string
ShowSignatureText:bool(optional)
Locations: (optional)
[
{
FileKey:string
PageNumber:string
Left:int
Top:int
Width:int
Height:int
}
]
}
],
Files:[
{
FileName:string
FileKey:string,
TempName:string
}
],
Distributions:
[
{
FullName:string
EMail:String
FileKeys: (optional)
[
string
]
}
]
}
Response:
{
StatusText:String,
StatusCode:int
}
Süreç Başlatma - Örnek İstek
{"AuthToken":"7OIUI4IWIUcL0nwB43SyPO1hplffSAFIkOFw3rcDPultF5r","Distributions":[{"FullName":"Suna Erbil","EMail":"suna.erbil@leafinbox.com","FileKeys":null}],"EntegrationKey":"testIlslemNo-637072654547456342","ParallelSignature":false,"SignatureType":"pades","Signers":[{"Index":"0","FullName":"Suna Erbil","EMail":"suna.erbil@leafinbox.com","SignType":"eSign","Step":1,"AlternativeIndex":null,"Locations":[{"FileKey":"file-test","PageNumber":"All","Left":-160,"Top":-70,"Width":120,"Height":50},{"FileKey":"file-multi","PageNumber":"0","Left":12,"Top":12,"Width":120,"Height":50}],"SignatureText":"Signed By Mavore","ShowSignatureText":true},{"Index":"1","FullName":"Sami Tezcan","EMail":"sami.tezcan@leafinbox.com","SignType":"eSign","Step":2,"AlternativeIndex":null,"Locations":[{"FileKey":"file-test","PageNumber":"1-3,6","Left":160,"Top":12,"Width":120,"Height":60},{"FileKey":"file-multi","PageNumber":"-1","Left":160,"Top":12,"Width":120,"Height":60}],"SignatureText":null,"ShowSignatureText":null}],"Subject":"Sign Test","SubjectDetail":"My signature test files","Files":[{"FileKey":"file-test","TempName":"44f8d100-9688-4dfc-ab04-a404fce422cc.pdf","FileName":"test.pdf","ContentType":"application/pdf"},{"FileKey":"file-multi","TempName":"36ed2f53-2e56-4094-8cf6-ac12c55cc591.pdf","FileName":"testMultipage.pdf","ContentType":"application/pdf"}]}
Süreç Başlatma - Örnek Cevap
{"StatusText":"Success","StatusCode":0,"Status":0}
Durum Sorgulama
Method : POST
ContentType : application/json
Header : Authorization:(AuthToken)
Url : state
Request : { EntegrationKey:string}
Response :
{
StatusText:String,
StatusCode:int
SignerStates:
[
{
SignerCode:string
ApiUrl:string
ShareUrl:string
Index:int
AlternativeIndex:int(optional)
Step:int
FullName:string
ReadDate:date (optional)
CompletedDate:date(optional)
IsActive:bool
}
]
ActiveSigners:
[
{
SignerCode:string
ApiUrl:string
ShareUrl:string
Index:int
AlternativeIndex:int(optional)
Step:int
FullName:string
ReadDate:date (optional)
CompletedDate:date(optional)
IsActive:bool
}
]
}
Durum Sorgulama - Örnek Cevap
{"ActiveSigners":[{"SignerCode":"MKIPI6IdIwbv483WMKoTbwrNcLCCqeUONM","ApiUrl":"http://localhost:2588/Sign?code=MKIPI6IdIwbv483WMKoTbwrNcLCCqeUONM","ShareUrl":"https://sign.leafinbox.com/LeafInboxSigning/SignDocument?code=MKIPI6IdIwbv483WMKoTbwrNcLCCqeUONM","Index":101426,"AlternativeIndex":null,"Step":1,"FullName":"Suna Tezcan","ReadDate":null,"CompletedDate":null,"IsActive":true}],"SignerStates":[{"SignerCode":"MKIPI6IdIwbv483WMKoTbwrNcLCCqeUONM","ApiUrl":"http://localhost:2588/Sign?code=MKIPI6IdIwbv483WMKoTbwrNcLCCqeUONM","ShareUrl":"https://sign.leafinbox.com/LeafInboxSigning/SignDocument?code=MKIPI6IdIwbv483WMKoTbwrNcLCCqeUONM","Index":101426,"AlternativeIndex":null,"Step":1,"FullName":"Suna Tezcan","ReadDate":null,"CompletedDate":null,"IsActive":true}],"StatusText":"SignInprogress","StatusCode":11,"Status":11}
Belge Listeleme
Method : POST
ContentType : application/json
Header : Authorization:(AuthToken)
Url : files
Request :
{
EntegrationKey:string
}
Response:
{
StatusText:String,
StatusCode:int
Files:
[
{
FileName:string
FileKey:string
}
]
}
Belge İndirme
Method : POST
ContentType : application/json
Header : Authorization:(AuthToken)
Url : file
Request :
{
EntegrationKey:string
FileKey:string
}
Response: binary data
Yeniden E-Posta Gönderimi
Method : POST
ContentType : application/json
Header : Authorization:(AuthToken)
Url : resendmail
Request :
{
EntegrationKey:string,
SignerCode:string
}
Response:
{
StatusText:String,
StatusCode:int
}
Belge Doğrulama
Method : POST
ContentType : application/json
Header : Authorization:(AuthToken)
Url : validate
Request :
{
EntegrationKey:string,
FileKey:string
}
Response:
{
StatusText:String,
StatusCode:int
SignatureType:string
Signers:
[
Index:int
Reason:String
Location:string
SignDate:string
SignerSubject:string
SignerName:string
SignerSubjectSerial:string
TimestampDate:string
SignerCertSerialHex:string
SignerCertBase64:string
IsVerified:bool(optional)
ValidationError:string
]
}
Belge Doğrulama İptali
Method : POST
ContentType : application/json
Header : Authorization:(AuthToken)
Url : removevalidation
Request :
{
EntegrationKey:string,
FileKey:string
}
Response:
{
StatusText:String,
StatusCode:int
}
Doküman Ekleme
Method : POST
Method : POST
ContentType : multipart/form-data
Header : Authorization:(AuthToken)
: Content-Disposition:attachment;name=FileKey;filename=FileName;filekey=FileKey
Url : appendfiles
Request1:{ EntegrationKey:string } FileData
Request2: url=> appendfiles?entegrationkeys = FileData
Response:
{
StatusText:String,
StatusCode:int,
Files:[
{
FileName:string
FileKey:string,
TempName:string
}
]
}