Bu dokümantasyon da açıklanan api istekleri, OfflinePro projesinin Gateway Platformları tarafından kullanılacak metotlarını içermektedir.
Aşağıdaki canlı ve test linklerini kullanarak, açıklaması yapılan metotlara ait api swaggerdan bilgi edinilebilir.
Test API Swagger:
Canlı API Swagger:
Authentication/Login
Url:
http://testgatewayapi.insurapps.net/api/authentication/login
Authorization Type: Bearer Token
Örnek Request:
{
"UserName": "omer.ipek@acerpro.com.tr",
"Password": "*Password*",
"WebApiKey": "3CA9380245DFBA53359FE7D41**"
}
Requestteki tüm alanlar zorunludur.
Örnek Response:
{
"Token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJmdXJrYW4uaW5jaUB2YWtpZmthdGlsaW0uY29tLnRyIiwianRpIjoiNjk2ODU5OGQtZmM1ZS00M2FiLWE2OWYtY2JjNmE0NTBhNDNjIiwicm9sZXMiOiJQbGF0Zm9ybVVzZXIiLCJBZ2VudElkIjoiMjEiLCJleHAiOjE4OTQ0MDE1MjMsImlzcyI6IkdhdGV3YXlQcm8iLCJhdWQiOiJHYXRld2F5UHJvIn0.oKWG69XQ-bePgvzm-gb23KZcQO5rmJdURwalFby5KUM",
"Expiration": "2018-08-16T10:38:43Z"
}
Token: Sistem tarafından üretilen token, platformların Gateway’ deki kullanıcı bilgilerini ve yetkilerini sağlayan bilgidir.
Request’ler esnasında Bearer Token olarak Authorization Type ile gönderilmesi gerekmektedir.
Expiration : Token’ın ömrünü belirtir. Expiration saat tipi TimeUtc’dir. Yani Türkiye saati ile +3 saat anlamına gelmektedir. Bu örnekte 2018-08-16 tarihinde Saat 10:38:43 +3 saat ile 13:38:43 itibari ile sonlanacaktır.
Önemli bir detay olarak, şu an tokenlarımızda refresh token bulunmamaktadır. Bir süre platformların, yapacakları isteklerden önce saati kontrol etmesi gerekmektedir.
Daha sonra ise Gateway tarafında yapılacak geliştirme ile istek esnasında platformların kullandığı token geçerli ise otomatik olarak token expiration süresi uzayacaktır. Bu geliştirme yapıldığında platforma bilgi iletilecektir.
*Önemli Not: Login’de dikkat edilmesi gereken nokta WebApiKey parametresi, her acenteye özel üretilen bilgidir. Bu bilgiyi request göndermeden önce, Gateway’den temin etmek gerekmektedir.
*Önemli Not2: Platformda offline istekte bulunacak kullanıcı OfflinePro sisteminde kayıtlı bir kullanıcı olmalıdır. Şöyle ki; işlemi yapacak olan kullanıcı Kağan Ayyıldız (kagan.ayyildiz@bankx.tr) isimli banka kullanıcısı olsun.
OfflinePro sisteminde bu kullanıcı kayıtlı olmayabilir.
Kullanıcının hangi acenteden istekte bulunduğu WebApiKey(bankx Üsküdar Şubesi Gateway Acente Id: 20) bilgisi ile doğrulanmaktadır.
OfflinePro sistemine kayıt edilen kullanıcı gönderilen WebApiKey bilgisindeki Gateway Acente Id’ye göre kaydedilmektedir.OfflinePro’da tanımsız kullanıcı ile işlem yapılmadığından gönderilen Email Adresi ve WebApiKey bilgisine göre sistemde kullanıcı oluşturulur.
OfflinePro iş akışı oluştururken, her bir iş akışı bir job kaydı ile başlar.
Teklif oluşturma fonksiyonlarında 3 farklı istek türü vardır.
1. Gateway teklif numarası parametre olarak gönderilmeden
Sadece ilgili model gönderilir, gateway request,operation watch, proposal bilgisi üretir.
2. Gateway teklif numarası parametre olarak gönderilerek
Online ürünlerden dönen hatalardan sonra üretilen Gateway teklif numarası(onlinede üretilen teklif no kullanılmaya devam etmektedir.) gönderilerek, offline teklif üretilir.
3. Prim indirim isteği
Daha önce üretilen ve prim girişi yapılmış olan teklife ait prim indirim isteğinde bulunulmasıdır. Platform tarafından yapılan bu istek sonrası mevcut job üzerinden prim indirim isteği oluşturulur.
Teklif numarası bilgisi göndermeden yapılan request.
Test Url:
Örnek Request:
{
"ProductIds":[3],
"ProductBranchId":1,
"Message":" Teklif istiyorum",
"Attachments": [
{
"Title": "dokuman.pdf",
"Type": "pdf"
},
{
"Title": "testtt23.pdf",
"Type": "pdf"
}
]
}
Not: ProductIds ve Attachments array parametredir. Attachments title
parametresi platform servislerinden çekilecek unique title bilgisine
sahip olan parametredir. Dosya, platform veritabanında hangi isim ile kaydedilmiş ise o bilgi title
bilgisidir.
Örnek Response:
{
"JobDetails": [
{
"JobId": 14155,
"ProposalId": 12088,
"ProductId": 3,
"InsuranceCompanyId": 3,
"CurrentStage": 1,
"JobStatus": 0
}
]
}
*Önemli Not: Teklifte, herbir ürüne ait sadece bir job kaydı oluşturulur ve response de
bu bilgi dönülür. Örnek; X ürünü, Y ürünü, Z ürünü için teklif oluşturulmak istendiğinde, bu üç
ürün için üç farklı job oluşturulur.
Not: Job Status isteğin genel durumunu belirtir. Bu JobStatus bilgisine ait enum bilgisi aşağıda paylaşılmıştır.
Teklif numarası bilgisi gönderilerek yapılan request.
Test Url:
Örnek Request:
{
"ProductIds":[12,13],
"ProductBranchId":5,
"ProposalId" : 10075,
"Message": "Online teklif offline düştü",
"Attachments": [
{
"Title": "test1.png",
"FileType": "png"
},
{
"Title": "testtt23.png",
"FileType": "png"
}
]
}
Not: ProductIds ve Attachments array parametredir. Attachments title
parametresi platform servislerinden çekilecek unique title bilgisine
sahip olan parametredir. Dosya, platform veritabanında hangi isim ile kaydedilmiş ise o bilgi title
bilgisidir.
Örnek Response:
{
"JobDetails": [
{
"JobId": 14156,
"ProposalId": 10075,
"ProductId": 14,
"InsuranceCompanyId": 5,
"CurrentStage": 1,
"JobStatus": 1
}
]
}
Mevcut teklife ait bilgisi göndermeden yapılan request.
Test Url:
http://testgatewayapi.insurapps.net/api/Jobs/11149/Premiums/RequestDiscount
11149 Örnek job numarasıdır, siz indirim isteğinde bulunmak istediğiniz job numarası bilgisi iletmelisiniz.
Örnek Request:
{
"ProductId": 3,
"Message": "Teklif indirim istiyorum indirimli teklif ver amıca.",
"Attachments": [
{
"Title": "platform.pdf",
"FileType": "pdf"
},
{
"Title": "platform indirim.pdf",
"FileType": "pdf"
}
]
}
Not: ProductIds ve Attachments array parametredir. Attachments title
parametresi platform servislerinden çekilecek unique title bilgisine
sahip olan parametredir. Dosya, platform veritabanında hangi isim ile kaydedilmiş ise o bilgi title
bilgisidir.
Örnek Response:
Status 200 Ok
Oluşturulan job’a ait prim girişi yapılmış ise platform tarafından poliçe isteği yapılabilecek fonksiyondur.
Test Url:
http://testgatewayapi.insurapps.net/api/Jobs/12149/OfflinePolicyRequest
12149 Örnek job numarasıdır. Platformlar, indirim isteğinde bulunmak istedikleri job numarası bilgisini iletmelidir.
Örnek Request:
{
"ProductId":3,
"Message":"Poliçe istiyorum.",
"Attachments": [
{
"Title": "test1.png",
"FileType": "png"
},
{
"Title": "testtt23.png",
"FileType": "png"
},
{
"Title": "dosyalar4.xlsx",
"FileType": "xlsx"
}
],
"RequestDetails" : [
{
"Id":66,
"KeyValue": ["3"],
"DisplayName": "Taksit Sayisi"
},
{
"Id":59,
"KeyValue": ["A"],
"DisplayName": "Ödeme Türü"
},
{
"Id":163,
"KeyValue": ["213123"],
"DisplayName": "Platform Teklif Numarası"
}
]
}
Not: ProductIds ve Attachments array parametrelerdir. RequestDetails array’i içerisinde, Gateway Key Value mantığında data gönderimi yapılmalıdır. Poliçe için örnek requestte gönderilmesi gereken keyler belirtilmiştir.
Önemli Not: Key Id bilgisi Gateway Key Id’sidir.
Örnek Response:
{
"JobDetails": [
{
"JobId": 12154,
"ProposalId": 10075,
"ProductId": 12,
"InsuranceCompanyId": 1,
"CurrentStage": 7,
"JobStatus": 1
}
]
}
Not: CurrentStage işlem sonucunda 7(Poliçe isteği) olarak güncellenmiştir. Job’a ait son durum CurrentStage bilgisinden takip edilebilir.
Oluşturulan job’a ait prim girişi ve poliçe isteği yapıldıktan sonra, platform tarafından zeyil isteği yapılabilecek fonksiyondur.
Test Url:
http://testgatewayapi.insurapps.net/api/Jobs/12149/OfflineEndorsementRequest
12149 Örnek job numarasıdır, platform tarafından indirim isteğinde bulunmak istendiğinde, job numarası bilgisi iletilmelidir.
Örnek Request:
{
"ProductId":3,
"Message":"Poliçe yapıldı zeyil istiyorum.!",
"RequestDetails" : [
{
"Id":315,
"KeyValue": ["1"],
"DisplayName": "Zeyil No"
},
{
"Id":59,
"KeyValue": ["T"],
"DisplayName": "Ödeme Türü"
},
{
"Id":163,
"KeyValue": ["20120"],
"DisplayName": "Platform Teklif Numarası"
}
]
}
Not: ProductIds ve Attachments array parametrelerdir. RequestDetails array’i içerisinde Gateway Key Value mantığında data gönderimi yapılmalıdır. Poliçe için örnek requestte gönderilmesi gereken key’ler belirtilmiştir.
Önemli Not: Key Id bilgisi Gateway Key Id’sidir.
Örnek Response:
{
"JobDetails": [
{
"JobId": 12155,
"ProposalId": 12089,
"ProductId": 13,
"InsuranceCompanyId": 5,
"CurrentStage": 10
}
]
}
Not: CurrentStage işlem sonucunda 10(Zeyil isteği) olarak güncellenmiştir. Job’a ait son durumu CurrentStage bilgisinden takip edilebilir.
Job ve Job action kayıtlarına ulaşabilmek için kullanılabilecek fonksiyonlar aşağıda ayrıntılandırılmıştır.
Mevcut job kaydına ait aksiyonları(actions) görüntüleyebilirsiniz.
Method Type: Get
Test Url:
http://testgatewayapi.insurapps.net/api/Jobs/12149/Actions
12149 Örnek job numarasıdır, platformlar indirim isteğinde bulunmak istediğinde, job numarası bilgisi iletmelidir.
http://testgatewayapi.insurapps.net/api/Jobs/12149/Actions?page=1&pagesize=10
Page sayfa bilgisini, PageSize sayfada görüntülenecek data sayısını belirtmektedir.
Örnek Response:
{
"Data": [
{
"Id": 120338,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-16T18:03:37.7766667",
"Message": "Merhaba",
"ToFullName": "furkan.inci@vakifkatilim.com.tr",
"ToUserName": "furkan.inci@vakifkatilim.com.tr",
"FromUserName": "omer.ipek",
"FromFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"Attachments": [],
"ToUserEmail": "furkan.inci@vakifkatilim.com.tr",
"FromUserMail": "omer.ipk@gmail.com"
},
{
"Id": 110367,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-14T18:29:53.6666667",
"Message": Zeyil rica ederim.",
"ToFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"ToUserName": "omer.ipek",
"FromUserName": "furkan.inci@vakifkatilim.com.tr",
"FromFullName": "furkan.inci@vakifkatilim.com.tr",
"Attachments": [],
"ToUserEmail": "omer.ipk@gmail.com",
"FromUserMail": "furkan.inci@vakifkatilim.com.tr"
},
{
"Id": 110365,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-14T17:31:39.0866667",
"Message": "Zeyil Reddedildi",
"ToFullName": "furkan.inci@vakifkatilim.com.tr",
"ToUserName": "furkan.inci@vakifkatilim.com.tr",
"FromUserName": "omer.ipek",
"FromFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"Attachments": [
{
"AttachmentId": 32,
"JobActionId": 110365,
"Title": "f2a84f98-dbe9-4aed-8949-4cfb99aa1416.pdf",
"AgentId": 0,
"FileType": "pdf",
"Bytes": null,
"ErrorExplanation": null
},
{
"AttachmentId": 33,
"JobActionId": 110365,
"Title": "61d182e1-3368-4acd-a794-89f8df7d3aba.pdf",
"AgentId": 0,
"FileType": "pdf",
"Bytes": null,
"ErrorExplanation": null
}
],
"ToUserEmail": "furkan.inci@vakifkatilim.com.tr",
"FromUserMail": "omer.ipk@gmail.com"
},
{
"Id": 110364,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-14T17:26:30.19",
"Message": "Zeyil talep etmekteyim.",
"ToFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"ToUserName": "omer.ipek",
"FromUserName": "furkan.inci@vakifkatilim.com.tr",
"FromFullName": "furkan.inci@vakifkatilim.com.tr",
"Attachments": [
{
"AttachmentId": 31,
"JobActionId": 110364,
"Title": "zeyil.png",
"AgentId": 0,
"FileType": "png",
"Bytes": null,
"ErrorExplanation": null
}
],
"ToUserEmail": "omer.ipk@gmail.com",
"FromUserMail": "furkan.inci@vakifkatilim.com.tr"
},
{
"Id": 110363,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-14T17:22:00.38",
"Message": "Poliçe iletiyorum.",
"ToFullName": "furkan.inci@vakifkatilim.com.tr",
"ToUserName": "furkan.inci@vakifkatilim.com.tr",
"FromUserName": "omer.ipek",
"FromFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"Attachments": [
{
"AttachmentId": 30,
"JobActionId": 110363,
"Title": "eee485f3-295e-4c89-8888-edca9632f4ed.pdf",
"AgentId": 0,
"FileType": "pdf",
"Bytes": null,
"ErrorExplanation": null
}
],
"ToUserEmail": "furkan.inci@vakifkatilim.com.tr",
"FromUserMail": "omer.ipk@gmail.com"
},
{
"Id": 110362,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-14T13:39:01.3633333",
"Message": "Poliçe alabilir miyim?",
"ToFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"ToUserName": "omer.ipek",
"FromUserName": "furkan.inci@vakifkatilim.com.tr",
"FromFullName": "furkan.inci@vakifkatilim.com.tr",
"Attachments": [
{
"AttachmentId": 27,
"JobActionId": 110362,
"Title": "test1.png",
"AgentId": 0,
"FileType": "png",
"Bytes": null,
"ErrorExplanation": null
},
{
"AttachmentId": 28,
"JobActionId": 110362,
"Title": "testtt23.png",
"AgentId": 0,
"FileType": "png",
"Bytes": null,
"ErrorExplanation": null
},
{
"AttachmentId": 29,
"JobActionId": 110362,
"Title": "dosyalar4.xlsx",
"AgentId": 0,
"FileType": "xlsx",
"Bytes": null,
"ErrorExplanation": null
}
],
"ToUserEmail": "omer.ipk@gmail.com",
"FromUserMail": "furkan.inci@vakifkatilim.com.tr"
},
{
"Id": 110361,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-14T13:38:04.8566667",
"Message": "teklif veriyom",
"ToFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"ToUserName": "omer.ipek",
"FromUserName": "omer.ipek",
"FromFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"Attachments": [
{
"AttachmentId": 26,
"JobActionId": 110361,
"Title": "04fb1243-f17d-4651-8d17-53a66a33088b.pdf",
"AgentId": 0,
"FileType": "pdf",
"Bytes": null,
"ErrorExplanation": null
}
],
"ToUserEmail": "omer.ipk@gmail.com",
"FromUserMail": "omer.ipk@gmail.com"
},
{
"Id": 110357,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-14T11:35:09.6066667",
"Message": null,
"ToFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"ToUserName": "omer.ipek",
"FromUserName": "omer.ipek",
"FromFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"Attachments": [
{
"AttachmentId": 21,
"JobActionId": 110357,
"Title": "d20e3aec-7d26-4de4-b878-87e15af25f99.jpg",
"AgentId": 0,
"FileType": "jpg",
"Bytes": null,
"ErrorExplanation": null
}
],
"ToUserEmail": "omer.ipk@gmail.com",
"FromUserMail": "omer.ipk@gmail.com"
},
{
"Id": 110356,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-14T11:34:46.5733333",
"Message": "---------------",
"ToFullName": "furkan.inci@vakifkatilim.com.tr",
"ToUserName": "furkan.inci@vakifkatilim.com.tr",
"FromUserName": "omer.ipek",
"FromFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"Attachments": [
{
"AttachmentId": 20,
"JobActionId": 110356,
"Title": "dadecac8-b714-48c2-a5d1-80b0af8f01c6.pdf",
"AgentId": 0,
"FileType": "pdf",
"Bytes": null,
"ErrorExplanation": null
}
],
"ToUserEmail": "furkan.inci@vakifkatilim.com.tr",
"FromUserMail": "omer.ipk@gmail.com"
},
{
"Id": 110355,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-14T11:33:36.11",
"Message": "Testtir.",
"ToFullName": "furkan.inci@vakifkatilim.com.tr",
"ToUserName": "furkan.inci@vakifkatilim.com.tr",
"FromUserName": "omer.ipek",
"FromFullName": "Ömer İPEK - Sigorta Şirketi Full User",
"Attachments": [],
"ToUserEmail": "furkan.inci@vakifkatilim.com.tr",
"FromUserMail": "omer.ipk@gmail.com"
}
],
"Page": 1,
"PageSize": 10,
"TotalCount": 13
}
Mevcut job kaydına ait actions(aksiyonları) görüntüleyebilirsiniz.
Method Type: Get
Test Url:
http://testgatewayapi.insurapps.net/api/Jobs/12149/Actions/110336
12149 Örnek job numarasıdır, platformlar indirim isteğinde bulunmak istediğinde job numarası bilgisi iletmelidir.
110336 Parametriktir, aksiyon numarasını temsil eder. Platformlar istekte bulunurken kendi job action numaranızı göndermelesiniz.
Örnek Response:
{
"Id": 110336,
"JobId": 12149,
"AgentId": 21,
"CreateDate": "2018-08-13T14:07:04.9933333",
"Message": " Teklif istiyorum",
"ToFullName": null,
"ToUserName": "furkan.inci@vakifkatilim.com.tr",
"FromUserName": "Ömer İPEK - Sigorta Şirketi Full User",
"FromFullName": null,
"Attachments": [
{
"AttachmentId": 1,
"JobActionId": 110336,
"Title": "test1.png",
"AgentId": 0,
"FileType": "png",
"Bytes": null,
"ErrorExplanation": null
},
{
"AttachmentId": 2,
"JobActionId": 110336,
"Title": "testtt23.png",
"AgentId": 0,
"FileType": "png",
"Bytes": null,
"ErrorExplanation": null
}
],
"ToUserEmail": null,
"FromUserMail": null
}
Mevcut job kaydına ait aksiyonların dökümanlarını görüntüleyebilirsiniz.
Method Type: Get
Test Url:
http://testgatewayapi.insurapps.net/api/Jobs/12149/Actions/110336/Attachments
12149 Örnek job numarasıdır, platformlar indirim isteğinde bulunmak istediğinde job numarası bilgisi iletmelidir.
110336 Parametriktir, aksiyon numarasını temsil eder. Platformlar istekte bulunurken kendi job action numarasını iletmelidir.
Örnek Response:
{
"Data": [
{
"AttachmentId": 1,
"JobActionId": 110336,
"Title": "test1.png",
"AgentId": 0,
"FileType": "png",
"Bytes": null,
"ErrorExplanation": null
},
{
"AttachmentId": 2,
"JobActionId": 110336,
"Title": "testtt23.png",
"AgentId": 0,
"FileType": "png",
"Bytes": null,
"ErrorExplanation": null
}
],
"Page": 1,
"PageSize": 10,
"TotalCount": 2
}
Job’a ait aksiyonun dökümanını görüntüleyebilirsiniz.
Method Type: Get
Test Url:
http://testgatewayapi.insurapps.net/api/Jobs/12149/Actions/110336/Attachments/19
12149 Örnek job numarasıdır, platformlar indirim isteğinde bulunmak istediğinde job numarası bilgisi iletmelidir.
110336 Parametriktir, aksiyon numarasını temsil eder. Platformlar istekte bulunurken kendi job action numarasını göndermelidir.
19 Ek dosyaya ait dosya numarasını temsil etmektedir. Platformlar istekte bulunurken kendi dosya numarasını, GetAll servisinden bilgiyi edindikten sonra parametre olarak göndermelidir.
Örnek Response:
{
"AttachmentId": 19,
"JobActionId": 110354,
"Title": "2986336a-f60a-4ae5-9e68-e48a791a4978.pdf",
"AgentId": 21,
"FileType": "pdf",
"Bytes": [ByteArray]
}
[Display(Name = "Mesaj")]
Message = 0,
[Display(Name = "Prim İsteği")]
PremiumRequested = 1,
[Display(Name = "Prim Reddedildi")]
PremiumRequestRejected = 2,
[Display(Name = "Prim Verildi")]
PremiumOffered = 3,
[Display(Name = "Prim Revize İsteği")]
PremiumReviseRequested = 4,
[Display(Name = "Prim Revize Gerçekleşti")]
PremiumRevised = 5,
[Display(Name = "Prim Revize Reddedildi")]
PremiumReviseRejected = 6,
[Display(Name = "Poliçe İsteği")]
PolicyRequested = 7,
[Display(Name = "Poliçe Reddedildi")]
PolicyRejected = 8,
[Display(Name = "Poliçe Gerçekleşti")]
PolicyMade = 9,
[Display(Name = "Zeyil İsteği")]
EndorsementRequested = 10,
[Display(Name = "Zeyil Reddedildi")]
EndorsementRejected = 11,
[Display(Name = "Zeyil Gerçekleşti")]
EndorsementMade = 12
[Display(Name = "Yeni")]
New,
[Display(Name = "Devam Ediyor")]
InProcess,
[Display(Name = "Durduruldu")]
Paused,
[Display(Name = "Kapatıldı")]
Closed