Event'ler
Bileşen standart DOM CustomEvent’leri yayınlar; addEventListener ile dinlersiniz. React’te karşılıkları onReady, onStepChange, onCaptured, onComplete ve onError prop’larıdır.
| Event | Ne zaman | detail |
|---|---|---|
ready |
SDK yüklendi ve akış başladı | — |
stepchange |
Adım değişti | { step, previous } |
captured |
Belge veya yüz yakalandı | Yakalanan medya |
complete |
Akış başarıyla bitti | Sonuç özeti |
error |
Hata oluştu | Hata bilgisi |
stepchange
Bölüm başlığı “stepchange”{ step: FlowStep; previous: FlowStep;}
type FlowStep = | 'idle' | 'select' | 'card-front' | 'card-back' | 'hologram' | 'face' | 'results' | 'complete' | 'error';captured
Bölüm başlığı “captured”Her yakalamada yayınlanır.
// Belge{ step: 'card-front' | 'card-back' | 'hologram'; image: string; // data URL blob: Blob; cardType: string;}
// Yüz{ step: 'face'; image?: string; video?: Blob;}complete
Bölüm başlığı “complete”{ transactionId: string; cardType: string | null; includeImages: boolean; cardFront?: { cardType: string; hasImage: true }; cardBack?: { cardType: string; hasImage: true }; hologram?: { cardType: string; hasImage: true }; face?: { hasImage: boolean; hasVideo: boolean }; skipped: { face: boolean; hologram: boolean; cardBack: boolean }; apiResults: Record<string, unknown>; // adım bazında Prove ID yanıtları}Varsayılan olarak medya eklenmez. include-images="true" verirseniz yakalama alanlarında görüntü ve video da yer alır.
{ code: | 'token_error' // token geçersiz veya oturum başlatılamadı | 'card_submit_failed' // belge gönderimi başarısız | 'face_verify_failed' // yüz doğrulanamadı | 'request_timeout' // zaman aşımı | 'flow_error'; // beklenmeyen hata message: string; retryable: boolean; // true ise kullanıcı tekrar deneyebilir step?: FlowStep; cause?: unknown;}| Kod | Tekrar denenebilir |
|---|---|
token_error |
Hayır |
card_submit_failed |
Evet |
face_verify_failed |
Deneme hakkı kaldıysa evet |
request_timeout |
Evet |
flow_error |
Hayır |
Belge gönderimi başarısız olursa veya zaman aşımına uğrarsa akış durur ve SDK kullanıcıya Yeniden dene seçeneği sunar; sonraki adıma sessizce geçilmez. retryable: false olan hatalarda kullanıcıya yeni bir oturum başlatın.
Pakette yardımcılar da vardır: SDK_ERROR_CODES, isRequestTimeout.