# Flutter

Последний релиз: версия 1.31.2

# Подготовка к работе с плагинами

Для работы любого из наших плагинов необходимо предварительно получить accessToken.

1. В дашборде IDnGO сгенерируйте appToken и secretKey.
2. Используя их, выполните API-запрос для получения accessToken.
   Подробная инструкция
3. Полученный токен используйте при инициализации SDK.

# Установка

1. Добавьте зависимость в файл pubspec.yaml:

dependencies:
  cyberity_mobilesdk_flutter_plugin: ^1.31.2

2. В командной строке выполните:

flutter pub get

3. Добавьте в iOS и Android части приложения зависимости от нашего MobileSDK:

# Android

• API уровня 23 (Android 5.0) или новее
• Kotlin 1.9.25 или новее

Добавьте репозиторий в android/build.gradle:

allprojects {
  repositories {
      // ...
      maven { url "https://maven.cyberity.ru/repository/maven-public/" }
      // ...
  }
}

# iOS

1. Добавьте в верхнюю часть ios/Podfile:

platform :ios, '13.0'

source 'https://cdn.cocoapods.org/'
source 'https://github.com/idngo/specs.git'

2. После установки пакета выполните команду:

npx pod-install

cd ios && pod update CyberityMobileSDK && cd ..

# Доступы к аппаратным функциям

Фреймворк запросит доступ к камере и микрофону, галерее фотографий и геолокации. По этой причине требуется наличие соответствующих описаний использования в файле Info.plist приложения. Тексты описаний можно изменять в соответствии с вашими требованиями.

plutil -insert "NSCameraUsageDescription" -string "Предоставьте доступ к камере для съемки фото" ios/Runner/Info.plist
plutil -insert "NSMicrophoneUsageDescription" -string "Предоставьте доступ к микрофону для записи видео с голосом" ios/Runner/Info.plist
plutil -insert "NSPhotoLibraryUsageDescription" -string "Предоставьте доступ к галерее для выбора фотографий" ios/Runner/Info.plist
plutil -insert "NSLocationWhenInUseUsageDescription" -string "Предоставьте доступ к вашему местоположению" ios/Runner/Info.plist

# Инициализация

# Настройка

Импортируйте класс в коде приложения.

import 'package:cyberity_mobilesdk_flutter_plugin/cyberity_mobilesdk_flutter_plugin.dart';

void launchCBRMobileSDK() async {
  // Перед запуском убедитесь, что настроен уровень проверки и получен accessToken для правильного окружения
  final String accessToken = "your_access_token";

  final onTokenExpiration = () async {
    // Вызывается при истечении срока действия токена 
    // Получите новый accessToken от своего бэкэнда
    // Пример реализации
    return Future<String>.delayed(
      Duration(seconds: 2),
      () => "your_new_access_token"
    );
  };
  // Необязательный обработчик для получения уведомлений о событиях
  final CBRStatusChangedHandler onStatusChanged =
      (CBRMobileSDKStatus newStatus, CBRMobileSDKStatus prevStatus) {
    print("The SDK status was changed: $prevStatus -> $newStatus");
  };

  final cbrMobileSDK = CBRMobileSDK.init(accessToken, onTokenExpiration)
    .withHandlers(onStatusChanged: onStatusChanged)
    .withDebug(true)
    .withLocale(Locale("en")) // Необязательный колбек для назначения другого системного языка
    .build();

  final CBRMobileSDKResult result = await cbrMobileSDK.launch();

  print("Completed with result: $result");
}

Метод cbrMobileSDK.launch() возвращает Future объекта CBRMobileSDKResult, который содержит статус SDK при его закрытии.

Результат CBRMobileSDKResult

Объект, описывающий результат последнего запуска SDK:

CBRMobileSDKResult(
  success: false,
  status: CBRMobileSDKStatus.Failed,
  errorType: CBRMobileSDKErrorType.Unauthorized,
  errorMsg: "Unauthorized access with accessToken=[your_access_token]",
  actionResult: null
)

# Запуск SDK

Далее вы можете использовать launchCBRMobileSDK, чтобы запустить SDK.

body: Center(
  child: Column(
    mainAxisAlignment: MainAxisAlignment.center,
    children: <Widget>[
        ...
      Container(
        alignment: Alignment.center,
        child: ElevatedButton(onPressed: () => launchCBRMobileSDK(),
        child: Text("Запустить SDK")),
      ),
        ...
    ],
  ),
),

# Закрытие SDK

По умолчанию, как только пользователь будет одобрен, SDK автоматически закрывается через 3 секунды. Вы можете настроить этот интервал времени или отключить автоматическое закрытие, установив значение 0:

cbrMobileSDK.withAutoCloseOnApprove(0)

Чтобы закрыть SDK программно воспользуйтесь:

cbrMobileSDK.dismiss()

# Дополнительные настройки

# Данные пользователя

При необходимости вы можете передавать эл. почту и/или номер телефона, которые будут изначально присвоены пользователю.

.withApplicantConf({
  "email": "...",
  "phone": "..."
})

# Предпочитаемые документы

Для шагов IDENTITY* (проверка документа) можно указать страну и тип документа, которые будут выбраны автоматически, минуя экран выбора типа документа.

Обратите внимание, что переданные параметры будут применяться только в том случае, если соответствующая комбинация страны и типа документа (idDocType) разрешена на этом шаге согласно настройкам уровня.

.withPreferredDocumentDefinitions({
  "IDENTITY": {
    "idDocType": "PASSPORT",
    "country": "USA"
  },
  "IDENTITY2": {
    "idDocType": "DRIVERS",
    "country": "FRA"
  }
})

# Переводы

Вы можете настроить тексты, используемые в SDK, в разделе Дешборда «Интеграции SDK».

Язык текста будет установлен в соответствии с настройками системы, но вы можете изменить его на нужный вам язык.

Для переопределения системного языка:

.withLocale(Locale("en"))

# Текстовые строки

Часть текста может быть задана локально и сохраняться при смене настроек языка SDK. Например, для ситуаций, когда сервер с переводом недоступен из-за отсутствия интернета, но нужно гарантированно отобразить определённый текст, используется локальное управление строками.

.withStrings({
  "sns_oops_network_title": "Oops! Seems like the network is down.",
  "sns_oops_network_html": "Please check your internet connection and try again.",
  "sns_oops_action_retry": "Try again"
})

# Аналитика

SDK собирает и отправляет данные об использовании на серверы IDnGO. Мы не отслеживаем чувствительные данные, отправляется только общая статистика использования. Она включает навигацию по экранам, взаимодействие с элементами интерфейса и так далее.

Мы анализируем эти данные для улучшения IDnGO. Данные не передаются третьим сторонам, и не используются для рекламы.

Для отключения аналитики данных воспользуйтесь:

.withAnalyticsEnabled(false)

# События

События SDK можно получать через onEvent:

final CBREventHandler onEvent = (CBRMobileSDKEvent event) {
  print("onEvent: $event");
};

final cbrMobileSDK = CBRMobileSDK.init(accessToken, onTokenExpiration)
  .withHandlers(
    onEvent: onEvent
  )

Каждое событие содержит eventType и набор параметров, упакованных в словарь payload.

CBRMobileSDKEvent(
  eventType: "StepInitiated",
  payload: {
    "idDocSetType": "IDENTITY"
  }
)

Поля элемента eventType

{
 "applicantId": "$applicantId" 
}

{
 "idDocSetType": "$idDocSetType" 
}

{
 "idDocSetType": "$idDocSetType",
 "levelName": "$levelName",
 "isCancelled": false 
}

{
 "eventName": "$eventName",
 "eventPayload": object 
}

# Действия пользователя

Чтобы использовать SDK в режиме действий пользователя необходимо создать уровень верификации с шагом проверки «Действие пользователя» (см. подробнее).

Токен доступа создается с параметрами userId, levelName, externalActionId.

# Справочник API

# Статусы SDK

# Типы ошибок errorType