Skip to content

Commit

Permalink
Update webhook-api-integration.md (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
canerinaliacerpro authored Nov 28, 2024
1 parent 4759f8e commit 579327c
Show file tree
Hide file tree
Showing 20 changed files with 3,053 additions and 133 deletions.
56 changes: 48 additions & 8 deletions docs/kullanici-rehberleri/webhook-api-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ Bir teklif primi InsurUp'a iletildiği zaman tetiklenir.

```json
{
"$event": "proposal_premium.received",
"proposalId": "673afd15f11de64fe1f2bjdb",
"productId": 40235,
"premiums": [
Expand All @@ -35,7 +36,8 @@ Bir teklif primi InsurUp'a iletildiği zaman tetiklenir.
"exchangeRate": 1,
"paymentType": "All",
"currency": "TurkishLira",
"insuranceCompanyProposalNumber": "142534209"
"insuranceCompanyProposalNumber": "142534209",
"proposalProductId": "67452b1a022dec6666bf06d8"
},
{
"installmentNumber": 2,
Expand All @@ -45,7 +47,8 @@ Bir teklif primi InsurUp'a iletildiği zaman tetiklenir.
"exchangeRate": 1,
"paymentType": "All",
"currency": "TurkishLira",
"insuranceCompanyProposalNumber": "142534209"
"insuranceCompanyProposalNumber": "142534209",
"proposalProductId": "67452b1a022dec6666bf06d8"
},
{
"installmentNumber": 3,
Expand All @@ -55,14 +58,20 @@ Bir teklif primi InsurUp'a iletildiği zaman tetiklenir.
"exchangeRate": 1,
"paymentType": "All",
"currency": "TurkishLira",
"insuranceCompanyProposalNumber": "142534209"
"insuranceCompanyProposalNumber": "142534209",
"proposalProductId": "67452b1a022dec6666bf06d8"
}
],
"insuredCustomer": {
"name": "Müşteri ismi",
"$type": "individual",
"identityNumber": "12345678910",
"birthDate": "1994-01-01",
"fullName": "Müşteri ismi",
"phoneNumber": {
"number": "5334180719",
"countryCode": 90
"number": "5432222222",
"countryCode": 90,
"areaCode": "543",
"numberWithoutAreaCode": "2222222"
},
"email": {
"value": "customer@insurup.com"
Expand All @@ -75,10 +84,40 @@ Bir teklif primi InsurUp'a iletildiği zaman tetiklenir.
"value": "1823",
"text": "KÜÇÜKÇEKMECE"
}
}
},
"event": 1,
"tempProposalDocumentUrl": null,
"tempPreInfoDocumentUrl": null
}
```

**Örnek Sigortalı Tüzel Müşteri Payload**

```json
"insuredCustomer": {
"$type": "company",
"title": "Şirket ismi",
"taxNumber": "6130782524",
"phoneNumber": {
"number": "5432222222",
"countryCode": 90,
"areaCode": "543",
"numberWithoutAreaCode": "2222222"
},
"email": {
"value": "customer@insurup.com"
},
"city": {
"value": "34",
"text": "İSTANBUL"
},
"district": {
"value": "1823",
"text": "KÜÇÜKÇEKMECE"
}
},
```

### `proposal_premium.purchasing` *sync*

Bir teklif primini satın alınmadan önce tetiklenir. Bu event'i satın alma validasyonu olarak kullanabilirsiniz.
Expand Down Expand Up @@ -124,7 +163,8 @@ Bir teklif primini satın alma isteği **başarılı** olunca tetiklenir.
"installmentNumber": 1,
"paymentType": "CreditCard",
"policyStartDate": "2024-11-20",
"policyEndDate": "2025-11-20"
"policyEndDate": "2025-11-20",
"tempDocumentUrl": null
}
```

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@
},
"dependencies": {
"@algolia/client-search": "^5.9.1",
"@docusaurus/core": "^3.5.2",
"@docusaurus/preset-classic": "^3.5.2",
"@docusaurus/core": "^3.6.3",
"@docusaurus/preset-classic": "^3.6.3",
"@docusaurus/theme-search-algolia": "^3.5.2",
"@mdx-js/react": "^3.0.0",
"algoliasearch": "^5.9.1",
Expand Down
37 changes: 37 additions & 0 deletions versioned_docs/version-0.1.32/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: Başlangıç
sidebar_position: 1
---

# InsurUp'a Hoş Geldiniz! 🚀

InsurUp, sigorta acenteleri ve brokerları için geliştirilmiş yenilikçi bir CRM çözümüdür. Kolay kullanımı, güçlü özellikleri ve esnek altyapısıyla, sigorta işlemlerinizi hızlı ve verimli bir şekilde yönetmenize olanak tanır. İster küçük bir acente olun, ister büyük bir broker ağı yönetin; InsurUp, sigorta süreçlerinizi daha kolay ve etkili hale getirir.

## 🌟 InsurUp Nedir?

InsurUp, sigorta acentelerinin ve brokerlarının iş süreçlerini kolaylaştırmak için özel olarak tasarlanmış bulut tabanlı bir CRM platformudur. Platform, sigorta acentelerinin teklif hazırlama, poliçe yönetimi, müşteri ilişkileri ve veri analizi gibi temel işlemlerini tek bir çatı altında toplar. Esnek ve kullanıcı dostu arayüzü sayesinde, herhangi bir teknik bilgi gerektirmeden kullanıcıların ihtiyaçlarına göre özelleştirilebilir ve kolayca adapte edilebilir.

Bulut tabanlı yapısı, kullanıcıların diledikleri yerden sisteme erişmelerine olanak tanırken, güçlü entegrasyon özellikleriyle sigorta şirketleriyle hızlı ve güvenli bağlantılar kurmalarını sağlar. Self servis modülleriyle kullanıcılar kendi başlarına acente kurulumlarını tamamlayabilir, teklifleri hızla hazırlayabilir ve müşteri bilgilerini tek bir ekranda görüntüleyebilir. Tüm bu özellikler, InsurUp'ı modern sigorta operasyonlarının merkezi haline getirir.

InsurUp hakkında daha fazla bilgi için [InsurUp web sitemizi](https://www.insurup.com) sayfamızı ziyaret edin.

## 🎯 Nasıl Başlayabilirsiniz?

Yeni bir kullanıcı olarak başlamak çok kolay! Adım adım kullanıcı rehberlerimizden faydalanarak hızlıca sistemi keşfedebilirsiniz. Başlamak için aşağıdaki adımları takip edin:

1. **[Giriş Yapın](./kullanici-rehberleri/giris-sayfasi)**: İlk adım olarak platforma giriş yapın ve hesabınızı aktif hale getirin.
2. **[Acentenizi Kurun](./kullanici-rehberleri/acente-bilgileri-ve-kurulum-adimlari)**: Acente bilgilerinizi girerek kurulum işlemini tamamlayın.
3. **[Kullanıcılarınızı Ekleyin](./kullanici-rehberleri/kullanicilar)**: Acenteniz için yeni kullanıcılar davet edin ve yetkilendirmeleri yapın.
4. **[Tekliflerinizi ve Poliçelerinizi Yönetin](./kullanici-rehberleri/teklifler)**: Hızlıca teklif hazırlayın ve poliçe süreçlerinizi yönetin.

## 📚 Kullanıcı Rehberleri

Platformdaki tüm modüller hakkında detaylı bilgi almak için [Kullanıcı Rehberleri](./kullanici-rehberleri) sayfamıza göz atabilirsiniz. Burada sistemdeki her özellik için adım adım açıklamalar bulacaksınız. Rehberlerimiz, sıkça karşılaşılan sorunlara ve merak edilen özelliklere dair pratik çözümler sunar.

## 📞 Yardıma mı ihtiyacınız var?

Herhangi bir konuda desteğe ihtiyaç duyarsanız, [Kullanıcı Rehberleri](./kullanici-rehberleri) sayfasından yardım alabilir veya [Destek Ekibi](mailto:destek@insurup.com) ile iletişime geçebilirsiniz.

---

InsurUp ile sigorta operasyonlarınızı daha verimli hale getirin, işinizi büyütün ve müşteri memnuniyetini artırın. Şimdi başlayın ve InsurUp'ın avantajlarını keşfedin! 🎉
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: "Acente Bilgileri ve Kurulum Adımları"
sidebar_position: 2
---

# Acente Bilgileri ve Kurulum Adımları

## Acente Bilgileri Ekranı

Bu ekranda acente adına, vergi numarasına ve levha kayıt numarasına dair bilgiler talep edilmektedir.

- **Acente Adı**: Acentenin resmi adını girmeniz gereken zorunlu bir alandır.
- **Vergi Numarası**: Acentenin vergi numarasını girmelisiniz. Bu alan da zorunludur.
- **Levha Kayıt No**: Acentenin levha kayıt numarasını bu alana girebilirsiniz. Bu alan zorunlu değildir ancak girilmesi önerilir.

Gerekli alanlar doldurulduktan sonra **"İleri"** butonuna tıklayarak bir sonraki adıma geçebilirsiniz.

## Acente Temsilcisi Ekranı

Bu adımda acente için InsurUp uygulamasına ilk giriş yapacak olan admin kullanıcı bilgileri girilmelidir.

- **Ad**: Acente temsilcisinin adı zorunlu olarak girilmelidir.
- **Soyadı**: Temsilcinin soyadı da zorunludur.
- **E-posta**: Temsilcinin kullanacağı e-posta adresini bu alana girmelisiniz. E-posta adresi, giriş işlemlerinde kullanılacaktır.
- **Parola**: Temsilci, bu alanda kendi belirleyeceği parolayı oluşturmalıdır. Parola daha sonra girişlerde kullanılacaktır.

Bu bilgilerin tamamı girildikten sonra yine **"İleri"** butonuna tıklayarak son adıma geçebilirsiniz.

## Sigorta Şirketi Bağlantısı Ekranı

Son adımda, acentenizle çalıştığınız sigorta şirketleriyle ilgili bağlantıların kurulması sağlanmaktadır.

### Sigorta Şirketi Eklemek

Bu adım zorunlu değildir, dilerseniz **"+"** butonuna tıklayarak sigorta şirketi bilgilerini ekleyebilirsiniz. Bu işlem için iki seçenek bulunur:

- **Web Servis**: Sigorta şirketleriyle olan bağlantıları web servisi aracılığıyla ekleyebilirsiniz.
- **Robot**: Sigorta şirketi bağlantılarını robot ile entegre edebilirsiniz.

Bağlantı kurulduktan veya bu adım atlandıktan sonra **"Tamamla"** butonuna tıklayarak InsurUp kurulum işlemini tamamlayabilirsiniz.

:::note
Bu işlemi uygulamaya giriş yaptıktan sonra da yapabilirsiniz.
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Giriş Sayfası"
sidebar_position: 1
---

# Giriş Sayfası

Bu ekran, InsurUp CRM'e erişim sağlamak isteyen kullanıcıların e-posta adresi ve şifre bilgileri ile sisteme giriş yapabilecekleri alandır. InsurUp'ı kullanan tüm acente ve broker kullanıcıları, kendilerine tanımlanan e-mail adreslerini ve şifrelerini kullanarak sisteme giriş yapabilirler.

## Giriş Yapma

- **E-mail Adresi**: Bu alana, daha önce sistem tarafından tanımlanmış e-posta adresinizi girin.
- **Şifre**: Sisteme giriş yaparken kullanacağınız şifreyi bu alana yazın.

Giriş bilgilerinizi girdikten sonra **"Giriş Yap"** butonuna basarak sisteme giriş yapabilirsiniz.

## Şifremi Unuttum

Bu ekran, şifrenizi hatırlamadığınız durumlarda yeni bir şifre talep edebileceğiniz bölümdür.

- **E-posta Adresi**: Sisteme kayıtlı olan e-posta adresinizi bu alana girin.

E-posta adresinizi girdikten sonra **"Gönder"** butonuna tıklayın. Bu işlem sonrası, şifrenizi sıfırlayabilmeniz için size bir bağlantı gönderilecektir. Gönderilen e-postadaki bağlantıya tıklayarak yeni bir şifre belirleyebilirsiniz.
59 changes: 59 additions & 0 deletions versioned_docs/version-0.1.32/kullanici-rehberleri/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
title: "Kullanıcı Rehberleri"
sidebar_position: 1
---

# 📘 Kullanıcı Rehberleri

Hoş geldiniz! Bu rehberde, InsurUp platformunun tüm modüllerini ve özelliklerini detaylı bir şekilde öğrenebilirsiniz. İster yeni bir kullanıcı olun, ister deneyimli bir acente temsilcisi; burada aradığınız tüm bilgilere kolayca erişebileceksiniz.

## 🚀 Hızlı Başlangıç

Platforma yeni mi başladınız? Endişelenmeyin, sizi adım adım yönlendireceğiz. Öncelikle [Giriş Sayfası](./kullanici-rehberleri/giris-sayfasi) rehberimizi inceleyerek başlayabilirsiniz.

## 📂 Bölümler

### Kurulum ve Genel Ayarlar
- [Giriş Sayfası](./kullanici-rehberleri/giris-sayfasi): Platforma nasıl giriş yapılır ve şifre sıfırlama adımları.
- [Acente Bilgileri ve Kurulum Adımları](./kullanici-rehberleri/acente-bilgileri-ve-kurulum-adimlari): Acente hesap kurulumunu nasıl yapacağınızı öğrenin.

### Yönetim ve Yetkilendirme
- [Kullanıcılar](./kullanici-rehberleri/kullanicilar): Kullanıcı ekleme, yönetme ve yetki düzenleme işlemleri.
- [Roller](./kullanici-rehberleri/roller): Kullanıcı rolleri ve yetkilendirme ayarları.

### Teklif ve Poliçe Yönetimi
- [Teklifler](./kullanici-rehberleri/teklifler): Teklif oluşturma ve listeleme özellikleri.
- [Teklif Detay](./kullanici-rehberleri/teklif-detay): Tekliflerin detaylı incelemesi ve karşılaştırma.
- [Poliçeler](./kullanici-rehberleri/policeler): Poliçelerin listelenmesi ve durumu hakkında bilgi.
- [Poliçe Detay](./kullanici-rehberleri/policeler-detay): Poliçe içeriklerinin detaylı görüntülenmesi ve düzenleme işlemleri.

### Müşteri Yönetimi
- [Müşteriler](./kullanici-rehberleri/musteriler): Müşteri bilgilerini yönetme, filtreleme ve yeni müşteri ekleme.
- [Müşteri Detay](./kullanici-rehberleri/musteri-detay): Müşterilere dair detaylı bilgilerin görüntülenmesi.

### Ek Özellikler ve Ayarlar
- [Self-servis Web Servis Partaj Ekleme](./kullanici-rehberleri/self-servis-web-servis-partaj-ekleme): Sigorta şirketleriyle bağlantı kurma ve partaj bilgileri ekleme.
- [Teminat Grupları](./kullanici-rehberleri/teminat-gruplari): Farklı sigorta branşları için teminat grupları oluşturma ve yönetme.

---

## 🎯 Nasıl Kullanılır?

Her bir rehberin içinde modüle dair ayrıntılı açıklamalar, adım adım yönlendirmeler ve ipuçları bulabilirsiniz. Özellikle belli bir işlemde zorlanıyorsanız, ilgili rehberi açarak hızlıca çözüm bulabilirsiniz. Ayrıca, rehberlerimizdeki arama ve filtreleme seçenekleri ile aradığınız bilgiye kolayca ulaşabilirsiniz.

:::tip
Yeni kullanıcı iseniz, önce kurulum ve genel ayarlar bölümlerini incelemeniz faydalı olacaktır. Böylece temel ayarları yapıp platformu rahatlıkla kullanabilirsiniz.
:::

## 💡 İpuçları ve Yardım

- **Sıkça Sorulan Sorular** bölümümüze de göz atarak hızlıca bilgi edinebilirsiniz.
- Destek ekibimizle iletişime geçmek için **yardım** simgesine tıklayarak bize mesaj gönderebilirsiniz.

## 📞 Destek Alın

Herhangi bir sorunuz veya takıldığınız bir nokta mı var? [Destek Ekibi](mailto:destek@insurup.com) ile iletişime geçin. Yardımcı olmaktan memnuniyet duyarız!

---

İhtiyacınız olan rehberin üzerine tıklayarak detaylı bilgi alabilirsiniz. Keyifli keşifler! ✨
45 changes: 45 additions & 0 deletions versioned_docs/version-0.1.32/kullanici-rehberleri/kullanicilar.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
---
title: "Kullanıcılar"
sidebar_position: 4
---

# Kullanıcılar

Kullanıcılar modülü, acentenin personel kayıtlarının yönetildiği ve kullanıcıların eklenip pasife alınabildiği alandır. Bu modülde kullanıcılar düzenlenebilir, pasifleştirilebilir, silinebilir veya tekrar aktivasyon e-postası gönderilebilir.

## Sütun Ayarları

Tablodaki bilgileri ihtiyacınıza göre görüntülemek için **Sütun Ayarları** alanını kullanabilirsiniz. Sütunları ekleyebilir veya kaldırabilirsiniz.

## Veri İndirme

**Veri İndirme** butonuna tıklayarak mevcut kullanıcı listesini Excel formatında bilgisayarınıza indirebilirsiniz.

## Yeni Kullanıcı Davet Etme

Sağ üstteki **"+"** butonuna tıklayarak **"Yeni Kullanıcı Davet Et"** pop-up ekranını açabilirsiniz. Buradan yeni kullanıcı daveti gönderebilirsiniz:

- **Ad**: Kullanıcının adı girilmelidir. Zorunlu bir alandır.
- **Soyad**: Kullanıcının soyadı girilmelidir. Zorunlu bir alandır.
- **E-Mail**: Kullanıcının e-posta adresi girilmelidir. Aktivasyon bağlantısı bu adrese gönderilecektir. Bu alan zorunludur.
- **Rol**: Kullanıcının rolü seçilmelidir. Roller daha önce roller modülünde tanımlanmış olmalıdır. Zorunlu değildir, sonradan da atanabilir.

**Kaydet** butonuna tıklayarak daveti tamamlayabilirsiniz.

:::info
Yeni kullanıcı davet edildiğinde, kullanıcıya bir aktivasyon e-postası gönderilecektir. Kullanıcı, bu e-postadaki bağlantıyı kullanarak hesabını aktif hale getirebilir.
:::

## Aksiyonlar

Tablonun sağ tarafında bulunan aksiyon butonlarıyla çeşitli işlemler yapılabilir:

- **Düzenle**: Kullanıcı bilgilerini düzenlemek için kalem ikonuna tıklayabilirsiniz.
- **Silme İşlemi**: Beklemede olan ve henüz giriş yapmamış kullanıcıları çöp kutusu ikonuna tıklayarak silebilirsiniz. Ancak Aktif veya Pasif olan kullanıcılar silinemez.
- **Durum Değiştirme**: Durum sütunundaki butonlar aracılığıyla bir kullanıcının durumu **Aktif** veya **Pasif** olarak değiştirilebilir.
- **Aktif Kullanıcı**: Kullanıcı sisteme giriş yapabilir.
- **Pasif Kullanıcı**: Pasif durumdaki kullanıcılar sisteme giriş yapamazlar. Ancak bir yönetici bu durumu Aktif hale getirene kadar beklemektedirler.

:::tip
Pasif durumda olan kullanıcılar, yönetici tarafından tekrar aktif hale getirildiğinde sistemdeki tüm yetkilerine geri sahip olurlar.
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: "Müşteri Detay"
sidebar_position: 10
---

# Müşteri Detay

Bu sayfa, müşteriye dair daha detaylı bilgilerin bulunduğu detay sayfadır. Üst kısımda, müşterinin kişisel bilgileri özetlenmiş olup temsilci ataması yapılabilir veya müşteri detayı kalem ikonuna tıklanarak düzenlenebilir. Alt kısımda ise müşterinin varlıkları, iletişim bilgileri, teklifleri, poliçeleri ve sağlık bilgileri hakkında daha detaylı alanlar bulunmaktadır.

## Varlıklar (Araçlar ve Konutlar)

Varlıklar, **Araçlar** ve **Konutlar** şeklinde iki başlığa ayrılmıştır. Buradan müşteriye ait varlıklar görüntülenebilir, yeni varlık eklenebilir ya da mevcut varlıklar düzenlenebilir veya silinebilir. Ayrıca sütun ayarları ve filtreleme özelliği de bulunmaktadır.

| Araçlar | Konutlar |
|---------------------------------|---------------------------------------------|
| Araç plakası, marka, model yılı | Metrekare, il, ilçe ve diğer ilgili detaylar|
| ve model bilgileri listelenir. | |

## İletişim Bilgileri

Müşterinin iletişim bilgilerinin tutulduğu alandır. Ayrıca sütun ayarları ve filtreleme özelliği de bulunmaktadır. İletişim bilgileri iki başlık altında tutulur:

- **E-Mailler**: Birden fazla e-posta eklenebilir. Bu e-postalardan biri **Birincil** olarak işaretlenebilir. Birincil e-posta tüm iletişimlerde esas alınır.
- **Telefon Numaraları**: Birden fazla telefon numarası eklenebilir. Tıpkı e-posta gibi bir numara **Birincil** seçilebilir.

## Teklifler

Müşterinin aldığı tüm teklifleri gösterir. Her teklif için sigortalı adı, prim aralığı (en yüksek ve en düşük prim), branş (kasko, trafik vb.), oluşturulma tarihi gibi detaylar listelenir.

| Özellikler | Açıklama |
|---------------------------------|-----------------------------------------------------------------------------------|
| **Sütun Ayarları** | Liste görünümünü özelleştirmenizi sağlar. |
| **Filtreleme** | Teklifleri filtreleyerek aradığınız bilgiyi hızlıca bulmanıza yardımcı olur. |
| **Arama** | Belirli bir teklif adına veya ID'sine göre arama yapabilirsiniz. |
| **Veri İndirme** | Teklif listelerini Excel formatında indirebilirsiniz. |
| **Teklif Alma** | Yeni teklif oluşturmak için kullanılabilir. |
| **Detay Erişimi** | Teklif satırında bulunan **"i"** ve **"ID"** butonlarına tıklayarak teklif detayına gidilebilir. |

## Poliçeler

Müşterinin sahip olduğu poliçeler listelenir. Poliçeler sekmesinde, poliçenin durumu, branşı, başlangıç ve bitiş tarihleri gibi bilgiler yer alır.

| Özellikler | Açıklama |
|---------------------------------|-----------------------------------------------------------------------------------|
| **Sütun Ayarları** | Liste görünümünü özelleştirmenizi sağlar. |
| **Filtreleme** | Poliçeleri filtreleyerek aradığınız bilgiyi hızlıca bulmanıza yardımcı olur. |
| **Arama** | Belirli bir poliçe adına veya numarasına göre arama yapabilirsiniz. |
| **Veri İndirme** | Poliçe listelerini Excel formatında indirebilirsiniz. |

## Sağlık Bilgileri

Müşterinin boy ve kilo gibi sağlık bilgileri bu bölümde tutulur. Bu bilgiler sağlık sigortası gibi özel sigorta türlerinde önemli bilgiler arasındadır.

:::info
Sağlık bilgileri, özellikle sağlık sigortası ürünleri için gereklidir ve doğru tutulması önemlidir.
:::
Loading

0 comments on commit 579327c

Please sign in to comment.