Backend - Integrations¶

Definitions¶

Bu dokümanda kullanılan terimler:

Terim	Tanım
Mobile Application	EnQualify'ın mobil özelliklerini barındıracak olan müşteriye ait mobil uygulama.
Integration Services	EnQualify'ın entegrasyon metodlarına erişen veya EnQualify için entegrasyon servisleri sağlayan üçüncü taraf uygulamalar.

Integration Points¶

EnQualify, Mobil Uygulamalar ve Entegrasyon Servisleri için üç entegrasyon noktası sunar:

Entegrasyon Noktası	Kullanan	Açıklama
Mobile SDK	Mobile Applications	Mobil uygulama entegrasyonları için kullanılır.
Web API (belirli metodlar)	Integration Services	Entegrasyon görevleri için belirli Web API metodları Integration Services tarafından çağrılır.
Integration API (müşteriye özel)	EnQualify → Integration Services	EnQualify'ın Integration Services'e erişmek için kullandığı, müşteriye özel geliştirilen API.

📌 Diyagramda entegrasyonda rol alan bileşenler kırmızı ile işaretlenmiştir: EnQualify Mobile SDK, EnQualify Web API, EnQualify Integration API ve Integration Services.

Mobile SDK¶

Mobil uygulama entegrasyonları EnQualify Mobile SDK aracılığıyla gerçekleştirilir.

Mobile SDK; EnQualify sunucularına erişmek ve mobil uygulamalarda doğrulama akışlarını ile UI öğelerini hayata geçirmek için gereken tüm fonksiyon ve bileşenleri içerir.
SDK, implementasyona özgü özellikler içermez; ancak özelleştirme imkânı sunar.
iOS ve Android platformlarında kullanılabilir.

ℹ️ Mobile SDK'ya ilişkin detaylı bilgi bu dokümanda yer almamaktadır. Detaylar için bkz. EnQualify Mobile SDK dokümanları.

Web API¶

Entegrasyon görevleri için Integration Services, EnQualify Web API'nin belirli metodlarını çağırır. Bu metodlar ve görevler ilerleyen bölümlerde detaylı olarak açıklanmaktadır.

Swagger Open API¶

EnQualify Web API uygulamalarının bir Swagger Open API sayfası ve JSON dosyası mevcuttur.

En güncel Web API metodları ve veri modelleri aşağıdaki URL'lerde erişilebilir:
https://enqualifyapi-test.enqura.com/swagger/index.html
https://enqualifyapi-test.enqura.com/swagger/v1.0/swagger.json
Farklı bir API üzerinde Swagger sayfasına erişmek için OpenAPI ayarının etkin olduğundan emin olunmalıdır.
Production ayarı etkinleştirilmişse Swagger sayfası görüntülenmez.
Swagger sayfası test amaçlı kullanılabilir.
Kolay entegrasyon için sağlanan Swagger Open API JSON dosyası kullanılabilir.

Integration API¶

Bazı entegrasyon özellikleri, EnQualify'ın Integration Services'e çağrı yapmasını gerektirir. Bu durumlar için Enqura, müşteriye özel bir Integration API uygulaması geliştirir.

Tüm Integration API'ler, EnQualify API'lerinin kullanacağı ortak API metodlarını sağlar.
EnQualify API'lerinin kullandığı ortak Integration API metodları, Integration Services tarafından doğrudan çağrılmaz.
Integration API'nin başka özellikleri veya ek API metodları bulunabilir.
Ortak Integration API metodları, Integration Services tarafından sağlanan metodlarla implemente edilmelidir.

Sequences¶

Aşağıdaki diyagram, entegrasyon fonksiyonlarının genel akış sırasını göstermektedir. Diyagram basitleştirilmiş olup bazı bileşen ve detaylar çıkarılmıştır. Entegrasyon fonksiyonları diyagramda kalın yazı ile belirtilmiştir.

Akış özeti:

Aşama	Aktörler	Temel Fonksiyonlar
Send Integration Data Before Call	Integration Services → Web API	`GetToken()`, `AddIntegration(Type, Reference, Identity, Data)`, `IDCheck()`
Before Call	Mobile → Mobile API	`Start()`, `GetToken()`, `SetSession(Type, Identity, Reference, Data)`, `DoControls()` → `AddFace()`, `AddIDDoc()`, `AddIDChip()`
Start Call	Mobile → Mobile API → Web API → Integration API	`StartCall()`, `GetUserMap()`, `AssignUser()`, `CheckCall()`, `Ask()`, `Start()`, `GetForm()`, `Notify()`
Call	Mobile ↔ Web API ↔ Web UI	`Communicate()`, `ShowForm()`, `Live()`, `Log()`
Mobile Ends Call	Mobile → Mobile API → Web API → Integration API	`End()`, `Hangup()`, `Notify()`, `Finish()`, `Finished()`, `Send()`, `GetSession()`