iOS

KOMOJU は、iOS モバイル アプリ内でのスムーズな支払い統合を可能にする、完全にローカライズされた iOS SDK を提供します。

Komoju Mobile payment SDK

Komoju Payment SDK

概要

KOMOJU iOS SDK は、UI がバックエンドと直接通信して機密性の高いクレジットカードデータを処理することで、PCI-DSS コンプライアンスの負担を軽減しながら支払いを安全に処理します。

サポートされている支払い方法

iOS SDK は日本のコンビニや PayPay を含む複数の支払い方法に対応しており、顧客の好みの支払いオプションに対応することができます。

コードリポジトリ

ソースコードは GitHub で無料で入手できます。簡単にテストおよびセットアップが行えるサンプル アプリケーションが含まれています。

支払いフロー

支払いフローは、セッションの作成、セッションの取得と SDK の初期化、支払い完了コールバックの処理、payment.captured Webhook の受信という4つの主要なステップで構成されています。

以下の図は全体的なプロセスを説明しています。

デモ

Soundbud!というビルド済みのデモ環境を用意していますので、その上でSDK の動作を確認することができます。Githubリリース ページの Assets セクションから、最新のビルドを入手してください。

はじめに

要件

  • Xcode 16+
  • iOS 15.3+

入手したSDKのバージョンに従って、依存関係をビルドスクリプトに追加してください。

GitHub Release

最新の GitHub リリースページ から最新の xcframework ZIP をダウンロードし、Xcode にドラッグ&ドロップします。

セッションの作成

安全なエンドポイントを設定し、バックエンドサーバーでSession オブジェクトを作成します(を参照)。

セッションを作成する時に、以下のように sessionId、publishableKey、および appScheme を SDK に渡す必要があります。

KOMOJU SDK の設定

let komojuSDKConfigurationBuilder = KomojuIosSDK.Configuration.Builder(
  // マーチャント用公開鍵
  publishableKey: publisherKey,
  // サーバーで作成したセッションID
  sessionId: sessionId,
  // アプリの URL スキーム(例: myapp)
  appScheme: appScheme
 )
// オプション設定

// SDK の言語を設定(デフォルトはシステム言語)
komojuSDKConfigurationBuilder.setConfigurableTheme(KomojuIosSDK.ConfigurableTheme(
                primaryColor: Color.green,
                primaryContentColor: Color.white,
                loaderColor: Color.green,
                primaryButtonCornerRadius: 16
            ))

// SDK 通貨の設定(デフォルトは日本円)
komojuSDKConfigurationBuilder.setCurrency(Currency.JPY)

// インラインクレジットカード決済処理の有効化(デフォルトは false)
// これは実験的機能で、OptIn `ExperimentalKomojuPaymentApi` が必要
komojuSDKConfigurationBuilder.setInlinedProcessing(boolean)

let komojuPaymentConfiguration = komojuSDKConfigurationBuilder.build()

 

決済 SDK の起動

let komojuPaymentConfiguration = // 上記の手順で作成

if komojuPaymentConfiguration?.canProcessPayment() ?? false {
    KomojuPaymentView(configuration: komojuPaymentConfiguration!) { result in
        // 結果をここで処理
        debugPrint("Payment Result -> \(result.isSuccess)")
    }
}

SDK テーマ

SDK のいくつかの UI コンポーネントはカスタマイズが可能です。以下の表を参照してください。

パラメータ設定内容戻り値
primaryColor決済ボタンなどの主要コンポーネントの色色値を表す整数
primaryContentColor主要コンポーネント内の内容(例: テキストやアイコン)の色色値を表す整数
primaryButtonCornerRadiusInDP主要ボタンのコーナー半径(DP単位)コーナー半径を表す整数(DP単位)
loaderColorローダー/スピナーの色色値を表す整数

デフォルトテーマは以下です。

primaryColor = 0xFF297FE7
primaryContentColor = 0xFFFFFFFF
primaryButtonCornerRadiusInDP = 8
loaderColor = 0xFF3CC239

デフォルトのテーマを上書きするには、デフォルトのテーマ オブジェクトをコピーして KomojuSDK.Configuration Builder に渡します。以下の例を確認してください。

komojuSDKConfigurationBuilder.setConfigurableTheme(KomojuIosSDK.ConfigurableTheme(
                primaryColor: Color.green,
                primaryContentColor: Color.white,
                loaderColor: Color.green,
                primaryButtonCornerRadius: 16
            ))

問題が発生した場合

何か問題が発生した場合やフィードバックがある場合は、お気軽にGitHub 報告してください。