IOS-SDK: відмінності між версіями

Матеріал з apidocs
Перейти до: навігація, пошук
 
(Не показано 15 проміжних версій цього користувача)
Рядок 1: Рядок 1:
{{APINav}}
== Введення ==
== Введення ==
----Ця документація описує процес інтеграції SDK для iOS у ваш проект. Дотримуйтесь кроків нижче, щоб успішно підключити та налаштувати SDK у вашому застосунку.
----Ця документація описує процес інтеграції SDK для iOS у ваш проект. Дотримуйтесь кроків нижче, щоб успішно підключити та налаштувати SDK у вашому застосунку.
Рядок 7: Рядок 8:


==== Крок 1: Завантажте EasyPaySdkIos.xcframework ====
==== Крок 1: Завантажте EasyPaySdkIos.xcframework ====
Перш за все, завантажте <code>EasyPaySdkIos.xcframework</code> та вставте його в папку вашого проєкту. Для цього просто перетягніть файл у ваш проєкт через Xcode.
Завантажте <code>EasyPaySdkIos.xcframework</code> за посиланням https://github.com/EasyPay-Mobile/EasyPay-Sdk-Ios та вставте його в папку вашого iOS проекту - <code>YourProject/iOS/Runner/.</code>


'''''Приклад:'''''[[Файл:Знімок екрана 2025-06-09 о 16.14.28.png|центр|міні|600x600пкс]]
'''''Приклад:'''''[[Файл:Знімок екрана 2025-06-09 о 16.14.28.png|центр|міні|600x600пкс]]
<br>
<br>


==== Крок 2: Перевірте, чи зʼявився фреймворк у розділі Frameworks, Libraries, and Embedded Content ====
==== Крок 2: Перевірте, чи зʼявився фреймворк ====
Переконайтеся, що фреймворк з'явився в розділі '''Frameworks, Libraries, and Embedded Content'''. Це можна перевірити в налаштуваннях вашого проєкту.
Переконайтеся, що фреймворк з'явився в розділі '''Frameworks, Libraries, and Embedded Content'''. Це можна перевірити в налаштуваннях вашого проєкту.
<br>
<br>
Рядок 20: Рядок 21:
Додайте папку <code>compose-resources</code>, яка знаходиться всередині <code>EasyPaySdkIos.xcframework</code>, до '''Copy Bundle Resources'''. Це дозволить вашому застосунку використовувати необхідні ресурси SDK.
Додайте папку <code>compose-resources</code>, яка знаходиться всередині <code>EasyPaySdkIos.xcframework</code>, до '''Copy Bundle Resources'''. Це дозволить вашому застосунку використовувати необхідні ресурси SDK.
[[Файл:Знімок екрана 2025-06-10 о 14.14.48.png|міні|677x677пкс|центр]]
[[Файл:Знімок екрана 2025-06-10 о 14.14.48.png|міні|677x677пкс|центр]]
'''''Важливо:''''' при додаванні compose-resources в діалозі додавання щоб у вас були обрані наступні опції:
* '''Destination:''' Copy items if needed
* '''Added folders:''' Create folder references
<br>
[[Файл:Знімок екрана 2025-06-11 о 13.14.53.png|центр|міні|600x600пкс]]
<br>
<br>


Рядок 49: Рядок 57:


== Ініціалізація оплати ==
== Ініціалізація оплати ==
----Для того, щоб ініціювати оплату, використовуйте наступний код:
----Для того, щоб ініціювати оплату, заповніть модель '''SdkPaymentContractArgs,''' необхідну для виклику '''SdkPaymentViewControllerKt.SdkPaymentViewController.'''
 
Якщо бажаєте, щоб користувач побачив сторінку з результатом оплати, встановіть значення '''showPaymentResult = true'''
 
<br>
<br>
'''Виклик функції оплати'''<syntaxhighlight lang="swift" line="1">
'''Виклик функції оплати'''<syntaxhighlight lang="swift" line="1">
Рядок 79: Рядок 90:


== Перехід на екран перегляду/додавання/видалення карток ==
== Перехід на екран перегляду/додавання/видалення карток ==
----Для того, щоб користувач міг переглядати або додавати картки, скористайтеся наступним кодом:
----Для надання користувачам можливості переглядати, додавати або видаляти картки, ви можете скористатися наступною функцією для навігації до відповідного екрану:<syntaxhighlight lang="swift" line="1">
<br>
'''Перехід на флоу перегляду/додавання/видалення карток'''<syntaxhighlight lang="swift" line="1">
@IBAction func navigateToCards(_ sender: Any) {
@IBAction func navigateToCards(_ sender: Any) {
     let vc = SdkCardsViewControllerKt.SdkCardsViewController(
     let vc = SdkCardsViewControllerKt.SdkCardsViewController(
         args: SdkCardsContractArgs(
         args: SdkCardsContractArgs(
             phoneNumber: "test-token-card",
             phoneNumber: ""380990000000"",
             urlToNotifyMerchant: nil // Optional
             urlToNotifyMerchant: nil // Optional
         )) {
         )) {
Рядок 97: Рядок 106:


</syntaxhighlight>
</syntaxhighlight>
=== Підсумок ===
# '''Завантажте та додайте SDK''': Завантажте '''EasyPaySdkIos.xcframework''', додайте його до вашого iOS проєкту через Xcode і переконайтесь, що фреймворк підключено коректно.
# '''Ініціалізація SDK''': У '''AppDelegate.swift''' ініціалізуйте SDK, додавши код в метод '''<code>didFinishLaunchingWithOptions</code>'''.
# '''Ініціалізація оплати''': Створіть модель '''<code>SdkPaymentContractArgs</code>''', налаштуйте параметри платежу і викликайте '''<code>SdkPaymentViewControllerKt.SdkPaymentViewController</code>''' для відображення екрану оплати.
# '''Перехід на екран карток''': Використовуйте '''<code>SdkCardsViewControllerKt.SdkCardsViewController</code>''' для навігації на екран карток користувача.

Поточна версія на 09:39, 11 вересня 2025

Merchant API

Головна сторінка

(Токенізація з передачею даних картки у запиті

Введення


Ця документація описує процес інтеграції SDK для iOS у ваш проект. Дотримуйтесь кроків нижче, щоб успішно підключити та налаштувати SDK у вашому застосунку.


Завантаження та додавання SDK до проєкту


Крок 1: Завантажте EasyPaySdkIos.xcframework

Завантажте EasyPaySdkIos.xcframework за посиланням https://github.com/EasyPay-Mobile/EasyPay-Sdk-Ios та вставте його в папку вашого iOS проекту - YourProject/iOS/Runner/.

Приклад:


Крок 2: Перевірте, чи зʼявився фреймворк

Переконайтеся, що фреймворк з'явився в розділі Frameworks, Libraries, and Embedded Content. Це можна перевірити в налаштуваннях вашого проєкту.

Крок 3: Додати папку compose-resources

Додайте папку compose-resources, яка знаходиться всередині EasyPaySdkIos.xcframework, до Copy Bundle Resources. Це дозволить вашому застосунку використовувати необхідні ресурси SDK.

Важливо: при додаванні compose-resources в діалозі додавання щоб у вас були обрані наступні опції:

  • Destination: Copy items if needed
  • Added folders: Create folder references



Ініціалізація SDK


Для ініціалізації SDK в вашому проекті необхідно додати код у файл AppDelegate.swift.
Крок 1: Імпортуйте SDK

import UIKit
import EasyPaySdkIos


Крок 2: Ініціалізація SDK

У методі application(_:didFinishLaunchingWithOptions:), додайте наступний код для ініціалізації SDK:

@main
class AppDelegate: UIResponder, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Ініціалізація SDK
        EasyPaySdk.shared.doInit(
            context: PlatformContext(),
            secret: "your secret",
            partnerKey: "your partner key",
            applePayMerchantId: "merchant.com.example"
        )
        return true
    }
}


Ініціалізація оплати


Для того, щоб ініціювати оплату, заповніть модель SdkPaymentContractArgs, необхідну для виклику SdkPaymentViewControllerKt.SdkPaymentViewController.

Якщо бажаєте, щоб користувач побачив сторінку з результатом оплати, встановіть значення showPaymentResult = true


Виклик функції оплати

@IBAction func makePayment(_ sender: Any) {
    let params = SdkPaymentContractArgs(
        paymentInstrumentArgs: PaymentInstrumentArgs(
            serviceKey: "SomeServiceKey",
            orderId: "SomeOrderId",
            amount: 3.0,
            description: "payment description",
            additionalItems: nil, // Optional
            phoneNumber: "380990000000" // Optional. Mandatory for saved cards to be displayed
        ),
        showPaymentResult: true
    )
    
    let vc = SdkPaymentViewControllerKt.SdkPaymentViewController(args: params) { result in
        print(result)
    }
    
    vc.modalPresentationStyle = .fullScreen
    vc.modalTransitionStyle = .crossDissolve
    self.present(vc, animated: true, completion: nil)
}


Перехід на екран перегляду/додавання/видалення карток


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

@IBAction func navigateToCards(_ sender: Any) {
    let vc = SdkCardsViewControllerKt.SdkCardsViewController(
        args: SdkCardsContractArgs(
            phoneNumber: ""380990000000"",
            urlToNotifyMerchant: nil // Optional
        )) {
        print("Finished")
    }
    
    vc.modalPresentationStyle = .fullScreen
    vc.modalTransitionStyle = .crossDissolve
    self.present(vc, animated: true, completion: nil)
}

Підсумок

  1. Завантажте та додайте SDK: Завантажте EasyPaySdkIos.xcframework, додайте його до вашого iOS проєкту через Xcode і переконайтесь, що фреймворк підключено коректно.
  2. Ініціалізація SDK: У AppDelegate.swift ініціалізуйте SDK, додавши код в метод didFinishLaunchingWithOptions.
  3. Ініціалізація оплати: Створіть модель SdkPaymentContractArgs, налаштуйте параметри платежу і викликайте SdkPaymentViewControllerKt.SdkPaymentViewController для відображення екрану оплати.
  4. Перехід на екран карток: Використовуйте SdkCardsViewControllerKt.SdkCardsViewController для навігації на екран карток користувача.