For the complete documentation index, see llms.txt. This page is also available as Markdown.

Android SDK

Ласкаво просимо до документації Identomat Android SDK! Тут ви знайдете все необхідне для безшовної інтеграції наших рішень з верифікації особи та KYC/AML у ваш Android-застосунок.

Остання версія: Version 1.1.189

Документація з інтеграції

Бібліотека Identomat пропонує потік ідентифікації користувача, що складається з різних кроків, поєднуючи типи документів із зображеннями чи відео користувача.

Для початку сесії за допомогою API Identomat необхідні такі кроки

1. Отримати токен сесії та налаштувати сесію

Щоб почати сесію, спочатку потрібно отримати session_token, викликавши ендпоінт begin/ та налаштувавши ваш потік верифікації.

⚠️ Примітка: Цей процес ідентичний для веб- та SDK-інтеграцій.

Повні деталі щодо генерації токена сесії, налаштування кроків та прапорців, а також запуску сесії див. у Посібнику з веб-інтеграції — ініціалізація сесії.

Отримавши токен сесії, ви можете продовжити інтеграцію його у ваш потік SDK.

2. Отримати екземпляр Identomat SDK та передати дані

Основний клас Identomat SDK — це клас IdentomatManager. IdentomatManager — клас-синглтон в Identomat SDK (з використанням класу Kotlin Object).

Щоб отримати екземпляр SDK, ви можете зробити таке:

  • Для Java: Ви можете отримати екземпляр за допомогою:

  • Для Kotlin: Ви можете використовувати його як IdentomatManager, що відноситься до класу Kotlin Object.

3. Передати токен сесії та обробити колбек

  • sessionToken – Відповідь від API: тип String.

Щоб передати токен сесії, ми використовуємо функцію setUp, яку можна викликати так:

Останній крок — передати функцію колбека, яка буде запущена після завершення взаємодії користувача з бібліотекою. Для цього використовуйте функцію .setCallback, яка приймає функцію як аргумент:

4. Запустити Identomat SDK

Бібліотека надасть нам Intent для головної активності SDK, яку ми можемо запустити так:

5. Передати додаткові змінні

Для налаштування бібліотеки Identomat під застосунок у нас є декілька додаткових функцій:

  1. setColors(colors: Map) - встановлює конкретні кольори

  2. setStrings(dict : Map) - встановлює конкретні текстові рядки

  3. setVariables(variables : Map<String, Any?>) - встановлює багато настроюваних змінних

  4. setLogo(() -> View?) - встановлює анімацію завантаження, приймає функцію, яка повертає view, приклад використання:

  5. back_button_icon- Змінює іконку кнопки «назад».

  6. primary_button_width – Налаштовує ширину основної кнопки.

  7. primary_button_height – Налаштовує висоту основної кнопки.

  8. liveness_smile_icon– Змінює іконку посмішки перевірки живості. Приклад: UIImage(named: "liveness_smile_icon")

Застарілі функції (Після версії 1.0.21)

Наступні функції застаріли після версії 1.0.21:

5.0 skipLivenessInstructions() - пропускає інструкції перевірки живості

5.1 setLivenessIcons(neutralFace: Int, smileFace: Int) - встановлює іконки перевірки живості, надсилайте int ресурсу так: R.drawable.ic_liveness_neutral_icon

5.2 setLivenessRetryIcon(retryIcon: Int?, size : Int) - встановлює головну іконку панелі повторних спроб перевірки живості, size встановлює розмір іконки

5.3 setRetryIcon(retryIcon: Int?, size : Int) - встановлює головну іконку панелі повторних спроб перегляду сканування документа, size встановлює розмір іконки

5.4 setCameraDenyIcon(cameraDenyIcon: Int?, size : Int) - встановлює головну іконку панелі повторних спроб перегляду сканування документа

5.5 setButtonCornerRadius(radius : Int) - встановлює радіус закруглення кутів кожної кнопки

5.6 setPanelElevation(elevation : Int) - встановлює підняття панелей


1. Налаштування кольорів

Використовуйте функцію setColors, щоб налаштувати кольори в бібліотеці відповідно до теми застосунку. Передайте словник, що містить відповідні ключі кольорів та їхні відповідні шістнадцяткові значення:

Приклад словника

  • для Java:

  • для Kotlin:

Спосіб передачі кольорів у бібліотеку: IdentomatManager.setColors(colors: colors)

2. Налаштування рядків

Щоб налаштувати рядки, які бібліотека відображає в конкретних місцях, у нас є функція setStrings(string: Map).

Функція setStrings приймає Map, де ключі відповідають ідентифікаторам рядків, що використовуються в бібліотеці, а значення — рядки, які ви хочете відображати для різних мов. Структура виглядає так:

Приклад для Java:

для Kotlin:

Кожен рядок має свій власний ключ у бібліотеці, і його можна змінити. Список ключів рядків наведено в кінці.

3. Налаштування змінних

Для будь-якого іншого налаштування ми використовуємо функцію setVariables(variables: Map<String, Any?>), куди ми передаємо мапу пар ключ-значення змінних.

Структура мапи виглядає так:

Ключі рядків (залишено англійською, оскільки це значення за замовчуванням у файлі ресурсів коду):

4. Встановлення користувацького логотипу

setLogo(() -> View?) Ця функція використовується для встановлення користувацького логотипу в бібліотеці. Ви можете передати власний користувацький view та відображати на ньому будь-що (анімації, зображення тощо). Цей логотип відображатиметься, коли бібліотека щось обробляє.


Last updated

Was this helpful?