Ana içeriğe geç

Backend - Integration API Functions

Bu bölüm, EnQualify Integration API'de implemente edilmesi gereken fonksiyonları açıklamaktadır.

📌 Önemli: Aşağıdaki API fonksiyonları, Integration Services tarafından sağlanan metodlarla birlikte implemente edilmelidir. EnQualify, bu metodları gerekli durumlarda Integration Services'e çağırır — tersine değil.


Integration/IDCheck — Kimlik Bilgisi Sorgulama

Arayan kişinin kimlik bilgisi Integration/Add ile gönderilmemişse veya sistemde bulunamazsa EnQualify, kimlik bilgisini Integration/IDCheck metoduyla Integration Services'ten talep eder.

Expected Request

Alan Açıklama
Reference Integration/Add'de gönderilen referans Id.
IdentityType Arayanın kimlik tipi.
IdentityNo Arayanın kimlik numarası.

Expected Response

Alan Açıklama
IDRegistration Kimlik kayıt verisi.
AddressRegistration Adres verisi.

Integration/Form — Özel Form URL'i Alma

Integration/Add içinde özel bir form URL'i sağlanmamışsa EnQualify, Integration/Form metoduyla bu URL'i Integration Services'ten talep eder.

Expected Request

Alan Açıklama
Reference Integration/Add'de gönderilen referans Id.
SessionUId EnQualify'daki çağrının Id'si.
IntegrationUId EnQualify'daki entegrasyon verisinin Id'si.

Expected Response

Alan Açıklama
FormUrl Form için kullanılacak URL.

Integration/Send — Tamamlanan Çağrı Bildirimi

Bir çağrı tamamlandığında EnQualify, Integration/Send metoduyla Integration Services'i bilgilendirir. Bildirim alındıktan sonra Integration Services, çağrı verisini Session/Get Web API metoduyla talep edebilir.

Expected Request

Alan Açıklama
Reference Integration/Add'de gönderilen referans Id.
SessionUId EnQualify'daki çağrının Id'si.
Reason Admin tarafından atanan çağrı sonuç kodu.
ReasonDetail Çağrı sonucu için girilen açıklama.
TaxNumber KYB akışında gönderilen vergi numarası.
NotifyType Bildirimin tetiklendiği olay tipi. Aşağıdaki değerlerden birini alır:

NotifyType Değerleri:

Değer Açıklama
AgentRatingWithReference (0) Agent değerlendirmesi yapıldığında. Referansı olmayan değerlendirmeler Integration/Send'e gönderilmez.
SessionAdd Oturum oluşturulduğunda.
IdTypeCheckStart / IdTypeCheckFinish Kimlik tipi kontrolü başladığında / tamamlandığında.
HologramStart / HologramFinish Hologram kontrolü başladığında / tamamlandığında.
OcrStart / OcrFinish OCR okuma başladığında / tamamlandığında.
NfcStart / NfcFinish NFC okuma başladığında / tamamlandığında.
FaceStart / FaceFinish Yüz tanıma başladığında / tamamlandığında.
RoomIdSend Video görüşme odası Id'si gönderildiğinde.
AgentCallAccepted Agent çağrıyı kabul ettiğinde.
AgentCallClose Agent çağrıyı kapattığında.
VideoUploadFinish Video yükleme tamamlandığında.
SessionClose Oturum kapatıldığında.
SigningSet / SigningFinish İmzalama ayarlandığında / tamamlandığında.

Integration/UserMap — Relationship Manager Kullanıcı Eşleştirme

Çağrı, Relationship Manager özelliği içeriyorsa EnQualify, doğru agent'ı bulmak için Integration/UserMap metodunu çağırır.

Expected Request

Alan Açıklama
Reference Integration/Add'de gönderilen referans Id.
IdentityType Arayanın kimlik tipi.
IdentityNo Arayanın kimlik numarası.
CallType Çağrı tipi.

Expected Response

Alan Açıklama
UserReference Kullanıcı referans kodu. EnQualify'da tanımlı kullanıcılardan biriyle eşleşmelidir. Birden fazla kullanıcı referansı döndürülebilir.
UserOrder Birden fazla kullanıcı döndüğünde kullanıcı sırası.
UserExpireDate Bu kullanıcı eşleştirmesinin son geçerlilik tarihi ve saati.