Entegrasyon Akışı

Bu sayfa, Ödeal Lead API ile entegrasyon sürecinin adım adım nasıl ilerleyeceğini açıklar.

Genel Süreç Akışı

1️⃣ Hazırlık Aşaması

API Bilgilerinizi Alın

Ödeal ile iletişime geçerek:

• API kullanıcı adı ve şifrenizi alın
• Stage ortam erişiminizi test edin
• İş ortağınıza özel parametreleri öğrenin

BİLGİ

Her iş ortağına özel olarak tanımlanan parametreler vardır (cihaz modeli, routing model vb.)

2️⃣ Dosya Yükleme

Başvuru oluşturmadan önce gerekli belgeleri yükleyin:

1. Dosya Hazırlama: Belgeleri desteklenen formatta hazırlayın
2. Base64 Encode: Dosyaları base64 formatına çevirin
3. Upload Request: /files endpoint'ine POST isteği gönderin
4. FileID Alma: Response'dan fileId değerini kaydedin

// Response örneği
{
  "fileId": "32ccd0e5-3375-4a86-b101-fda30348413d"
}

3️⃣ Başvuru Oluşturma

İki farklı yöntemle başvuru oluşturabilirsiniz:

Yöntem A: Register Endpoint (Detaylı)

Tüm bilgileri tek seferde göndererek başvuru oluşturun:

• Şirket bilgileri
• Yetkili bilgileri
• Cihaz bilgileri
• Yüklenen dosyalar

Yöntem B: Lead Endpoint (Esnek)

Minimum bilgi ile başvuru oluşturun, detaylar iş ortağı bazlı:

• Temel iletişim bilgileri
• Opsiyonel alanlar

HANGISI DAHA UYGUN?

• Register: Tüm bilgilere sahipseniz ve tek seferde göndermek istiyorsanız
• Lead: Aşamalı veri toplama yapıyorsanız veya daha esnek bir yapı istiyorsanız

4️⃣ Başvuru Takibi

Başvuru oluşturduktan sonra:

{
  "registerRefCode": "52127791-94bf-4c77-b345-8e396b05c767"
}

Bu registerRefCode ile başvuru durumunu sorgulayın:

• INPROGRESS: Başvuru inceleniyor
• APPROVED: Başvuru onaylandı, satış tamamlandı
• REJECTED: Başvuru reddedildi

5️⃣ Servis Yönetimi

Başvuru onaylandıktan ve cihaz kurulumu tamamlandıktan sonra:

Servis Talebi Oluşturma

• Arıza bildirimleri
• Malzeme talepleri
• Versiyon güncellemeleri

Servis Takibi

claimId ile servis talebinin durumunu izleyin.

6️⃣ İptal İşlemleri

Gerektiğinde başvuruları iptal edebilirsiniz:

DELETE /register/{registerRefCode}

UYARI

Satışa dönüşen başvuruların iptali için Ödeal ile iletişime geçilmelidir.

Operasyonel Süreç

Zaman Çizelgesi

Aşama	Tahmini Süre
Başvuru gönderimi	Anlık
Ödeal değerlendirmesi	~3 iş günü
Onay/Red bildirimi	Anlık
Cihaz kurulumu	Değişken

Durum Bildirimleri

Başvuru durumu değiştiğinde:

• Callback servisi ile bildirim (opsiyonel)
• Veya düzenli durum sorgulaması yapın

Hata Yönetimi

Entegrasyon sırasında hatalarla karşılaşabilirsiniz:

{
  "error": {
    "code": "REG-CITY-2",
    "message": "Girmiş olduğunuz il kayıtlarımızda bulunmuyor"
  }
}

Her endpoint için detaylı hata kodları dokümantasyonda mevcuttur.

Test Ortamı Kullanımı

1. Stage ortamında test edin: Tüm işlevleri gerçek veri kullanmadan deneyin
2. Gerçek senaryolar oluşturun: Başvurudan servise kadar tüm akışı test edin
3. Hata durumlarını test edin: Hatalı veri göndererek validasyonları kontrol edin
4. Production'a geçin: Testler başarılı olduktan sonra canlıya alın

Sonraki Adımlar