Перед тем как интегрировать Долями SDK, вам необходимо предоставить вашему персональному менеджеру из команды Долями SDK следующие данные:

Инструкция по установке в Installation.md

Для работы с SDK от вашего бэкенда требуется ТОЛЬКО:

• поддержка вебхука Долями
• умение вызывать Commit, Cancel, Info и Refund для работы с заказом

URL на который будет приходить вебхук вы можете передать вашему контакту Долями или указать в notificationUrl.

Для работы с SDK Долями вашему бэкенду НЕ нужно вызывать Create!

Минимальная версия iOS 12.0, bitcode выключен.

Для интеграции SDK нужно:

• встроить настройки NSAppTransportSecurity в Info.plist
• встроить в свой интерфейс кнопку Оплатить Долями, класс DolyamePaymentButton.
• создать объект координатора SDK, класс DolyamePaymentCoordinator
• подписаться на результат работы координатора, проперти, DolyamePaymentCoordinator.onFinish.
• вызвать start на DolyamePaymentCoordinator

Нужно добавить qr.nspk.ru, cdn-tinkoff.ru, tinkoff.ru, tcsbank.ru и dolyame.ru в App Transport Security - Excluded Domains. Для каждого из них нужно сделать AllowsInsecureHTTPLoads = YES и, обязательно, NSIncludesSubdomains = YES. Также необходимо указать свойство AllowsArbitraryLoadsInWebContent = YES.

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSAllowsArbitraryLoads</key>
    <false/>
    <key>NSAllowsArbitraryLoadsInWebContent</key>
    <true/>
    <key>NSExceptionDomains</key>
    <dict>
        <key>qr.nspk.ru</key>
        <dict>
            <key>NSExceptionAllowsInsecureHTTPLoads</key>
            <true/>
            <key>NSIncludesSubdomains</key>
            <true/>
        </dict>
        <key>cdn-tinkoff.ru</key>
        <dict>
            <key>NSExceptionAllowsInsecureHTTPLoads</key>
            <true/>
            <key>NSIncludesSubdomains</key>
            <true/>
        </dict>
        <key>tinkoff.ru</key>
        <dict>
            <key>NSExceptionAllowsInsecureHTTPLoads</key>
            <true/>
            <key>NSIncludesSubdomains</key>
            <true/>
        </dict>
        <key>tcsbank.ru</key>
        <dict>
            <key>NSExceptionAllowsInsecureHTTPLoads</key>
            <true/>
            <key>NSIncludesSubdomains</key>
            <true/>
        </dict>
        <key>dolyame.ru</key>
        <dict>
            <key>NSExceptionAllowsInsecureHTTPLoads</key>
            <true/>
            <key>NSIncludesSubdomains</key>
            <true/>
        </dict>
    </dict>
</dict>

Этот класс является саб-классом UIView и функционирует как обычная UIView сверстанная на AutoLayout. По дизайну, на данный момент, это широкая кнопка с текстом "Оплатить Долями" в одну строку, который помещается только в полную ширину экрана, в недалеком будущем подразумевается создание альтернативной, узкой версии которую можно будет посместить на половину ширины экрана.

Кнопка "Оплатить Долями" из коробки имеет характерный дизайн продукта Долями и не требует никакой конфигурации. Не является обязательным условием реализации. Можно создать свой уникальный элемент интерфейса для перехода к оплате Долями.

Не ставье NSLayoutConstaint на высоту кнопки Долями. Доверьтесь той высоте, которую кнопка хочет сама по себе.

При нажатии на кнопку будет вызван event handler onButtonPressed, который приложение интегратор выставляет на инстансе кнопки через проперти DolyamePaymentButton.onButtonPressed.

public class DolyamePaymentButton: UIView {
    public var onButtonPressed: (() -> Void)?
}

Этот хэндлер будет вызываться при каждом нажатии на кнопку и в результате работы этого хэндлера, вы должны сами перейти к следующему шагу работы с Долями SDK.

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

Начиная с 2022 года, в App Store для страны Китай нельзя использовать API CallKit. При этом, символы и модуль могут быть упомянуты, однако на стороне кода должна быть бизнес-логика которая определяет что приложение запущено в Китае и отключает использование этих API. При этом на этапе ревью придет reject, и Apple запросит подтверждение, что действительно в приложении есть такая бизнес-логика. Нужно указать, что "да" и затем ревью будет пройдено.

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

Если ваше приложение не выклыдывается в китайский стор или вы никогда не сталкивались с такой проблемой App Review, то рекомендуем никогда не отключать это поведение. Именно поэтому этот флаг по-умолчанию true.

Идентификатор заказа Order.id должен быть уникальный при каждом запуске SDK. Если пользователь:

• попал во флоу Долями SDK чтобы оплатить заказ
• не оплатил заказ
• вернулся в ваше приложение
• захотел опять попасть во флоу Долями SDK То:
• обязательно Order.id должен отличаться от того, с каким юзер уже заходил в Долями SDK.

При запуске флоу в SDK сохраняется полученный CustomerInfo.id. При последующих запусках SDK происходит проверка CustomerInfo.Id:

• если был получен идентичный id, то авторизация в SDK сохраняется
• если был получен id, отличный от сохранённого при предыдущем запуске, то пользователь будет разлогинен и должен будет заново пройти процесс авторизации

Имея собранный объект конфигурации, мы имеем все что нужно для того чтобы отправить пользователя во флоу Долями.

Этот класс является точкой входа и выхода для всего флоу.

Для того чтобы начать работу, необходимо создать координатор. Ниже представлен перечень параметров.

Вам необходимо хранить этот интанс координатора после создания. Если вы отпустите инстанс координатора, это нарушит работоспособность SDK.
Также, мы не храним сильную ссылку на UIViewController, который вы нам передаете, во избежание retain-цикла.

В конце своей работы, координатор уведомит вас о том, что он закончил работать. Здесь, координатор уберет все экраны которые сам создавал для того, чтобы вернуть приложение в то состояние, в котором вы передали его SDK.

Публичный интерфейс конца работы флоу SDK выглядит следующим образом:

public enum DolyamePaymentCoordinatorResult {
    case success
    case failure
    case pending
    case dismissed
}

public class DolyamePaymentCoordinator {
    public var onFinish: ((DolyamePaymentCoordinatorResult) -> Void)?
}

Вам необходимо выставить DolyamePaymentCoordinator.onFinish. Внутри него вам обязательно нужно удалить координатор оттуда, куда вы его записывали.

Вот что обозначают значения этого результата:

Сейчас, когда координатор сконфигурирован, его можно запустить. Запуск приведет к показу экранов и запуску логики SDK.

Запуск производится посредством вызова метода DolyamePaymentCoordinator.start.

public class DolyamePaymentCoordinator {
    public func start()
}

Для того чтобы не тестировать на проде, SDK предлагает возможность проверки интеграции через демо заявку.

Отличия демо-заявки от нормального флоу:

• перед запуском основного флоу вам будет показан экран, на котором вы можете выбрать результат, чем флоу кончится
• не будет производиться работа с эквайрингом. При этом, подтверждение платежа будет приходить аналогично настоящему.

Есть три варианта окончания флоу:

1. Отказ скоринга
2. Успешная оплата 1го платежа
3. Неуспешная оплата 1го платежа

Шаги для запуска демо-заявки:

• в конфигурации Partner нужно указать notificationUrl, чтобы он указывал на ваше тестовое окружение. Если вы не укажете здесь notificationUrl, то вы не получите подтверждения платежа, даже если при интеграции вы давали дефолтный URL. Так как он не тестовый, а боевой.
• передайте в demoFlow значение true

В процессе работы SDK Долями могут возникнуть непредвиденные ситуации. С точки зрения UX, мы берем на себя реагирование на них и правильный вывод пользователя из флоу SDK обратно в приложение партнера. Однако, для целей проверки интеграции, во время тестирования подключенного SDK, вам стоит подписаться на эти события, чтобы быть в курсе, если вы сделали что-то неправильно.

Хэндлер события вызыватся в результате работы с сервером, и не сразу. Когда вы только откроете SDK, хэндлер не будет вызван и вам нужно пойти дальше по флоу, чтобы проверить появление (или отсутствие) какого-то события. Хэндлер события может быть вызван на любой DispatchQueue, но это не страшно потому что вы не должны проводить никакие манипуляции с интерфейсом. Не забудьте про weak self.

Подписаться на события можно через DolyamePaymentCoordinator.onUnexpectedEvent:

public enum DolyameUnexpectedEvent {
    case lessThanRuble
    case haveSumDifference
    case haveItemsDifference
    case wrongPersonData
    case noPartnerForClient
}

public class DolyamePaymentCoordinator {
    public var onUnexpectedEvent: ((DolyameUnexpectedEvent) -> Void)?
}

Далее представлена таблица неожиданных событий.