iOS

これはSwift向けの公式Dodo Payments iOSチェックアウト SDKです。ネイティブブラウザビューでDodoのホスト型チェックアウトを開き、型付きの結果を返します。

Checkout Sessions API

バックエンドから、このSDKが開くcheckout_urlを作成します。

Mobile Integration Guide

これがモバイル決済フロー全体の中でどのように機能するかを確認します。

iOS SDKはDodoのホスト型チェックアウトをSFSafariViewControllerで開き、API keyを保持せず、Dodo APIを直接呼び出すこともありません。チェックアウトのロジックはすべてブラウザで実行され、SDKはビューのライフサイクルを管理し、return URLを取得するだけです。 iOS 16以降、Swift 6が必要です。

インストール

Add the Package

Xcodeで File → Add Package Dependencies に移動し、次を入力します。

https://github.com/dodopayments/dodopayments-mobile-sdk-ios

バージョン1.0.0以降を選択します。または、Package.swiftに追加します。

Package.swift

.package(url: "https://github.com/dodopayments/dodopayments-mobile-sdk-ios", from: "1.0.0")

アプリは、チェックアウトからのreturn URLを受け取るためにURL schemeを登録する必要があります。これをInfo.plistに追加します。

Info.plist

<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLName</key>
    <string>myapp</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>myapp</string>
    </array>
  </dict>
</array>

Xcodeの Info → URL Types UIから追加することもできます。

使用方法

import DodoCheckout

let result = try await DodoCheckout.start(
    checkoutUrl: checkoutUrl,   // from your backend's checkout session
    returnUrl: URL(string: "myapp://checkout/return")!,
    onEvent: { event in print(event.name) }  // logging only
)

switch result.status {
case .succeeded: showSuccess(result.paymentId)
case .failed:    showFailure()
case .cancelled: dismiss()
case .pending:   showPending()
case .expired:   showExpired()
}

Return URLの転送

SFSafariViewControllerには、自身のreturn URLを捕捉するプロセス内の方法がありません。アプリで受信したURLをSDKに転送する必要があります。

SwiftUI
SceneDelegate

.onOpenURL { url in
    DodoCheckout.handleOpenURL(url)
}

SceneDelegate.swift

func scene(_ scene: UIScene, openURLContexts URLContexts: Set<UIOpenURLContext>) {
    guard let url = URLContexts.first?.url else { return }
    DodoCheckout.handleOpenURL(url)
}

ここではすべてのURLを安全に転送できます。handleOpenURLは、登録済みのreturnUrlに一致するURLに対してのみ動作し、それ以外の場合はfalseを返します。

結果の意味

result.statusはUI上のヒントであり、支払いの証明ではありません。すべての支払いを、payment.succeeded / subscription.active webhookを介してバックエンドで確認してください。

CheckoutStatus

必須

succeeded、failed、cancelled、pending、expiredのいずれかです。

String?

return URLに含まれている場合に設定されます。UIに表示しますが、アクセスの許可には使用しないでください。詳しくは以下の「支払いの確認」を参照してください。

String?

subscription checkoutの場合に設定されます。

[String]?

チェックアウトにlicense key productsが含まれている場合に設定されます。

String?

チェックアウトでemailが取得された場合に設定されます。

[String: String]

return URLのすべてのquery parameterをそのまま保持します。

支払いの確認

Webhooks

支払いが成功したとき、またはsubscriptionが有効になったとき、Dodo Paymentsはバックエンドを呼び出します。

Get Payment Detail

secret keyを使用してpaymentIdを検索し、そのstatusを直接確認します。

これらのいずれかによって支払いが確認された後にアクセスを許可してください。result.statusだけで許可してはいけません。

外観のカスタマイズ

シートの閉じるボタン、表示スタイル、カラースキームを customization の start(...) でカスタマイズできます。すべてのフィールドはオプションです。省略すると、customization は iOS のデフォルトの SFSafariViewController 外観を使用します。

DismissButtonStyle

閉じるボタンのラベルまたはアイコン：done、close、または cancel。

PresentationStyle

pageSheet はスワイプで閉じるカードとして表示されます。fullScreen は画面全体を覆います。

Bool

スクロール時にツールバーを折りたためるようにします。presentationStyle が fullScreen の場合のみ表示されます。pageSheet は、この設定にかかわらずバーを固定したままにします。

ColorScheme

デバイスのシステム設定にかかわらず、ライトまたはダークの外観を強制します：system、light、または dark。

let result = try await DodoCheckout.start(
    checkoutUrl: checkoutUrl,
    returnUrl: URL(string: "myapp://checkout/return")!,
    customization: BrowserCustomization(
        dismissButtonStyle: .close,
        presentationStyle: .fullScreen,
        colorScheme: .dark
    )
)

エラー

start が CheckoutError をスローするのは、誤用またはプラットフォームの障害が発生した場合のみです。キャンセルまたは拒否された支払いは常に結果として返され、例外にはなりません。

invalidCheckoutUrl（INVALID_CHECKOUT_URL）：有効な checkout.dodopayments.com セッション URL ではありません。
invalidReturnUrl（INVALID_RETURN_URL）：有効な絶対 URL ではありません。
alreadyInProgress（ALREADY_IN_PROGRESS）：チェックアウトはすでに実行中です。
platformError（PLATFORM_ERROR）：予期しないプラットフォーム障害です。

放棄されたセッション

チェックアウトの途中でアプリが終了した場合は、次回の起動時にセッションを復元し、バックエンドと照合してください。

import DodoCheckout

if let abandoned = DodoCheckout.getAbandonedSession() {
    // reconcile abandoned.sessionId with your backend, then:
    DodoCheckout.clearAbandonedSession()
}

Mobile Integration Guide

Android、React Native、Flutter でも同じコントラクトを使用します。

React Native SDK

iOS 上で同じ Swift コアをラップします。

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Checkout Sessions API

Mobile Integration Guide

インストール

使用方法

Return URLの転送

結果の意味

支払いの確認

Webhooks

Get Payment Detail

外観のカスタマイズ

エラー

放棄されたセッション

関連項目

Mobile Integration Guide

React Native SDK

Checkout Sessions API

Mobile Integration Guide

​インストール

​使用方法

​Return URLの転送

​結果の意味

​支払いの確認

Webhooks

Get Payment Detail

​外観のカスタマイズ

​エラー

​放棄されたセッション

​関連項目

Mobile Integration Guide

React Native SDK

インストール

使用方法

Return URLの転送

結果の意味

支払いの確認

外観のカスタマイズ

エラー

放棄されたセッション

関連項目