Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #11 from omise/dedupe-plugin-documentation
Move usage docs to website
- Loading branch information
Showing
1 changed file
with
11 additions
and
135 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,141 +1,17 @@ | ||
| # OmiseExt EC-CUBE 2.13.3 plugin | ||
| <!--- KEEP START ---> | ||
| [](https://www.omise.co/developers) | ||
|
|
||
| [EC-CUBE](http://www.ec-cube.net)用のOmiseの決済モジュールを追加するプラグインです。 | ||
| [Omise](https://www.omise.co/ja)は、タイ、日本、シンガポールでサービスを提供する決済サービスプロバイダーです。 | ||
| どのような規模の加盟店でも、Omiseが提供するAPIを活用し、オンライン決済を受領することができます。 | ||
| <!--- KEEP END ---> | ||
|
|
||
| このプラグインはEC-CUBE上でのクレジット決済をOmiseで行う機能を提供します。 | ||
| Omiseは決済（仮売上、実売上、返金）の機能を提供し、商品や受注はEC-CUBEで独立して管理する仕様です。 | ||
| **Omise EC-CUBE**は、Omiseを介してEC-CUBE上での決済処理をサポートする公式プラグインです。 | ||
|
|
||
| 購入者によるクレジットカード情報の入力、課金の作成（仮売上 or 実売上）、課金の実売上化、課金の返金のみを管理し、それ以外の機能は持ちません。 | ||
| ## ご利用方法 | ||
|
|
||
| Omiseで行った決済には、ECCUBEのorder_idをCharge APIのdescriptionへ保存するため、[ダッシュボード](https://dashboard.omise.co/) のグローバルサーチで `order_id: 6` などのテキストで検索することが可能です。 | ||
| ※ `order_id: 6` は、dtb_orderテーブルで管理している、order_idのことです。 | ||
| インストールや設定の詳細は [公式ドキュメント](https://www.omise.co/ja/eccube-plugin) を参照してください。 | ||
|
|
||
| ## ご協力のお願い | ||
|
|
||
|
|
||
| ## 機能 | ||
|
|
||
| - [Omise](https://dashboard.omise.co/signup)にメールアドレスとパスワードを登録するだけですぐ試せます | ||
| - Omiseでは、トークン機能を用いるため EC-CUBE のサーバでカード情報を一切扱いません | ||
| - EC-CUBE の登録ユーザと Omise の顧客を紐付けることにより、ログインしていれば次回以降はカード情報を入力せず利用できます | ||
| - EC-CUBE 内の注文、ユーザデータと Omise の課金、顧客データを ID で対応づけて管理できます | ||
| - カード情報は Omise のサーバで[安全](https://www.omise.co/security)に管理されます。 EC-CUBE のサーバで厳しいカード情報の保存要件を満たす必要はありません | ||
| - プラグインの設定 サンドボックスで、APIのテストキーかライブキーを利用するかを選択できます。 | ||
| - プラグインの設定 キャプチャで、購入時に仮売上か実売上化するかを選択できます。 | ||
|
|
||
|
|
||
| ## 注意事項 | ||
|
|
||
| - EC-CUBE 2.13.3 での動作を保証します。 | ||
| - PHP 5.3 以上でのみ動作します。PHP 5.2 はすでにサポートが終了しており、安全でないためサポートしません。 | ||
| - トークン決済に JavaScript が必要なため、携帯電話端末では利用できません。 | ||
| - [omise-php v2.4.1](https://github.com/omise/omise-php/releases/tag/v2.4.1)を当プラグインで利用しています。 | ||
|
|
||
| ## インストール方法 | ||
|
|
||
| こちらから [omise-eccube.tar.gz](https://github.com/omise/omise-eccube/blob/master/release/omise-eccube.tar.gz?raw=true) をダウンロードします。 | ||
|
|
||
| EC-CUBEの管理画面でオーナーズストアのプラグイン管理を開き、先ほど作成した `omise-eccube.tar.gz` を選択し、インストールボタンをクリックします。 | ||
|
|
||
|  | ||
|
|
||
|
|
||
| インンストール後、プラグインを有効にするため、チェックボックスをONにします。 | ||
|
|
||
|  | ||
|
|
||
| その後、 `プラグイン設定` をクリックし、Omise決済プラグイン設定を開きます。 | ||
|
|
||
|  | ||
|
|
||
| この画面では、下記の設定をしてください。 | ||
|
|
||
| **Omise API keys ( LIVE )** | ||
|
|
||
| [LIVE Keys](https://dashboard.omise.co/live/api-keys) より、キーセットを確認し、設定してください。 | ||
| LIVEダッシュボードがアクティブでない場合は、TESTのキーセットを入力してください。 | ||
| LIVEダッシュボードは、必要書類をウェブから提出後に利用できるようになります。 | ||
|
|
||
| **Omise API keys ( TEST )** | ||
|
|
||
| [TEST Keys](https://dashboard.omise.co/test/api-keys) より、キーセットを確認し、設定してください。 | ||
|
|
||
| **サンドボックス** | ||
|
|
||
| テスト環境での、プラグインの動作確認の場合は、テストモードでご利用ください。 | ||
| 本番環境で利用される場合は、ライブモードを選択してください。 | ||
|
|
||
| **キャプチャ** | ||
|
|
||
| 購入時に仮売上をするメリットは、管理者が在庫確認後、商品の提供が間違いなく行えると認識した段階で、受注画面から手動で実売上にすることができることです。 | ||
| また、仮売上状態で7日以上経過すると自動的にオーソリがキャンセル扱いになるため、決済手数料が発生しません。 | ||
| 実売上後の返金は、決済手数料が発生します。 | ||
| ご利用に最適な方法を選択してください。 | ||
|
|
||
| *Omiseクレジット決済の予備知識* | ||
|
|
||
| | 状態 | 内容 | | ||
| |:--|:--| | ||
| | 仮売上から7日経過してvoidされた | 誰も損しない | | ||
| | 実売上して返金した | 加盟店が決済手数料分を損する | | ||
|
|
||
|
|
||
| **支払い方法の名称変更** | ||
|
|
||
| 当プラグインでは、支払い方法のデフォルト名称を `クレジットカード決済[Omise]` と設定しています。 クレジットカード決済は、幾つかのモジュールでも提供されているため、初期値は判別のつくようにしています。 | ||
|
|
||
|  | ||
|
|
||
| 支払い方法の名称は、 `基本情報管理＞支払い方法設定` より、 `クレジットカード決済[Omise]` -> `クレジットカード決済` へ名称を編集することをお勧めします。 | ||
| これは、ユーザーが購入時の支払い方法で表示されるためです。 | ||
|
|
||
|
|
||
| **配送方法設定から、取扱支払方法にクレジットカード決済を追加** | ||
|
|
||
| 最後に、Omiseのクレジットカード決済を有効にしたい配送方法を開き、 `取扱支払方法` でチェックボックスをONにしてください。 | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| これで、選択された配送方法の商品の購入時に、Omiseのクレジット決済が利用できるようになります。 | ||
|
|
||
|
|
||
| ## アップデート方法 | ||
|
|
||
| アップデートの提供は予定していません。 | ||
|
|
||
|
|
||
| ## 利用方法 | ||
|
|
||
| - 試しになにかの商品を購入し、支払方法に「クレジットカード決済」を指定すると、カード情報を入力する画面に遷移します。 | ||
|  | ||
|
|
||
| - クレジットカード情報を入力し、購入できることを確認してください。 | ||
|  | ||
|
|
||
| - [Omiseのテストダッシュボード](https://dashboard.omise.co/test/charges)で、正しく課金が作成されたことを確認してください。 | ||
|  | ||
|
|
||
| - 仮売上を利用する設定にした場合、受注詳細画面から実売上化できることを確認してください。 | ||
|  | ||
|
|
||
| - 返金をしたい場合、受注詳細画面から返金ボタンをクリックして、返金できることを確認してください。 | ||
|  | ||
|
|
||
|
|
||
| ## ログ | ||
|
|
||
| このプラグインは、Omiseとの通信内容を一切保存しません。 | ||
| Omiseのログを参照するには、ダッシュボードへアクセスしてください。 | ||
|
|
||
| - [テスト・ログ](https://dashboard.omise.co/test/logs) | ||
| - [ライブ・ログ](https://dashboard.omise.co/live/logs) | ||
|
|
||
| 当プラグインは、設計上、購入者の個人情報、クレジットカード情報、EC-CUBE の設定情報がログに出力されることはありません。 | ||
| スクリプトを変更する際はこの点が維持されるよう注意してください。 | ||
|
|
||
|
|
||
| # ライセンス | ||
|
|
||
| このリポジトリに含まれるプログラムはOmiseが権利を有しており、 | ||
| MIT License のもとで配布されます。 | ||
| Omise EC-CUBEの改善に貢献していただける方を歓迎いたします。 | ||
| プルリクエスト、問題の報告、不具合の修正にご協力ください。 |