14.8. クレジットカードゲートウェイ

3scale では、クレジットカードによる支払いに関して以下の支払いゲートウェイとのインテグレーションが提供されます。

  • BraintreeBlue
  • Stripe
  • Adyen
警告

Authorize.Net および Ogone インテグレーションは非推奨です。新しいインテグレーションはサポートされません。2018 年 7 月 27 日より前に存在していたインテグレーションについては、Red Hat ではサポートを提供しますが、完全にサポートされる支払いゲートウェイのいずれかに移行することを推奨します。

14.8.1. Stripe インテグレーション (推奨)

以下の手順により、アカウントの支払いゲートウェイとして Stripe を設定する方法を説明します。これにより、開発者は自分のクレジットカード情報を入力し、お客様は API へのアクセスに対する課金を計算された請求書に従って Stripe を通じて自動的に行うことができます。

有料 API 用にクレジットカードへの課金を有効にする場合、主要なステップの 1 つは 支払いゲートウェイ を設定することです。3scale アカウントで使用することのできる支払いゲートウェイは多数あります。ここでは、Stripe に関する手順を説明します。

14.8.1.1. 前提条件

以下の手順を始める前に、Stripe のアカウントを作成する必要があります。

14.8.1.2. Stripe からの API キーの取得

Stripe アカウントにログインし、https://dashboard.stripe.com/account/apikeys で API キーを取得します。「秘密」鍵および「公開」鍵の 2 つの鍵が必要です。テストを行う場合には「テスト」セットを使用し、課金を開始する準備ができたら「ライブ」セットを使用します。

Stripe Integration

14.8.1.3. 3scale 設定の定義

これらの API キーの使用を開始するように 3scale を設定する必要があります。そのためには、3scale 管理ポータルにログインし、Audience > Billing > Charging & Gateway の順に移動します。

Billing page

Charging enabled のチェックボックスが選択されていない場合には、選択して Save をクリックします。

Enable charging

ページ最下部近くの Gateway セクションに、ドロップダウンが表示されるはずです。それを Stripe に変更します。

Billing gateway

ドロップダウンの下のフォームが変わり、2 つのフィールドが表示されるはずです。Stripe の API キーを入力し、Save をクリックします。

Stripe billing gateway

支払いゲートウェイを変更すると、いくつかの警告が表示される場合があります。これは想定される状況です。表示されたら、警告を読んで了承してください。

これで支払いゲートウェイは設定されましたが、CMS では設定されていないため、ユーザーはまだ使用できない可能性があります。デベロッパーポータルに移動し、左側のナビゲーションペインでテンプレート Payment Gateway および Show をクリックします。

Developer portal - Billing

{% when "braintree_blue" %} の前に以下のコードがまだ表示されていない場合には、コード追加します。

{% when "stripe" %}
 <p><a href="{{ current_account.edit_stripe_billing_address_url }}">Edit billing address</a></p>

 {% if current_account.has_billing_address? %}
   {% stripe_form "Edit Credit Card Details" %}
 {% else %}
   <p>After entering billing address, the option to enter credit card will be enabled.</p>
 {% endif %}

最後に、Save および Publish をクリックします。これで、ユーザーは Stripe ゲートウェイを使用して費用を支払うことができるはずです。

注記

Stripe からのデータを 3scale のデータとマッピングするには、Stripe フィールド metadata.3scale_account_reference を使用することができます (構成は 3scale-[PROVIDER_ID]-[DEVELOPER_ACCOUNT_ID])。

14.8.2. Adyen インテグレーション

以下の手順により、アカウントの支払いゲートウェイとして Adyen を設定する方法を説明します。これにより、開発者は自分のクレジットカード情報を入力し、お客様は API へのアクセスに対する課金を計算された請求書に従って Adyen を通じて自動的に行うことができます。

有料 API の使用に対してクレジットカードへの課金を有効にする場合、支払いゲートウェイを設定することが主要なステップです。3scale アカウントで使用することのできる支払いゲートウェイは多数あります。ここでは、Adyen に関する手順を説明します。

14.8.2.1. 前提条件

  • 以下の手順を始める前に、Adyen のアカウントを作成する必要があります。
  • そのサブアカウントとして、Company アカウントおよび Merchant アカウントが必要です。
  • Adyen のライブアカウントを申請するには、満たさなければならない要求事項が多数あります。要求事項の詳細については、こちら をご確認ください。
  • アカウントは実稼働モードでなければなりません。

14.8.2.2. Adyen インテグレーションの設定

Adyen アカウント情報の確認

  1. まず初めに、Adyen アカウントにログインします。次に、Settings > Users セクションでご自分のクレデンシャルを探し、以下に示すビューのドロップダウンメニューから System を選択します。
docs billing Adyen settings
  1. Company アカウント (リストの一番上にあるアカウント) をクリックします。これにより、Company アカウントの設定ビューに移動します。
docs billing Adyen view credentials
  1. こうして、ログイン名シークレットパスワードクライアント暗号化用公開鍵業者 ID、および ライブラリーの場所 を把握することができます。これらの情報が 3scale の請求設定で必要です。
  2. 公開鍵 を表示するには、Generate Password をクリックしてこのパスワードをどこかにコピーする必要があります。
docs billing Adyen credentials

3scale アカウントでの支払いゲートウェイの設定

  1. Audience > Billing > Charging & Gateway の順に移動し、チェックボックスを選択してクレジットカードへの課金を有効にし、Save をクリックします。
  2. Adyen ゲートウェイへのリンクを作成するために設定しなければならないフィールドが、すべて表示されます。
  3. Gateway のドロップダウンメニューから Adyen を選択し、変更を保存する必要があります。
docs billing Adyen settings

Adyen API レスポンスでの alias 追加データの有効化

デフォルトでは、クレジットカード承認リクエストが 3scale から Adyen に送信されると、返されるレスポンスにはクレジットカードの一意の識別子は含まれません。

正しいクレジットカードの参照が 3scale に保存され、正しいカードに課金が行われるようにするには、この追加データを有効にする必要があります。

Adyen のサポートに連絡し、承認リクエストのレスポンスで alias 追加データを有効にします。

請求ワークフローのテスト

  1. 前払いモード を有効にして 1 日程度で請求書が生成されるようにし、テストサイクルを短縮します。
  2. 続いて、既存のテスト用アカウントを選択し、請求用の費用項目を追加して請求書を作成します。

    1. 直ちにアカウントに対して課金を行います。
    2. このテスト法には若干のコストが発生しますが、その価値はあります。ご自分の API を使用する開発者に実際に請求を行う前に、すべてが正常に動作することを確認できるので、安心材料となります。

これで支払いゲートウェイは設定されましたが、CMS では設定されていないため、ユーザーはまだ使用できない可能性があります。Developer Portal タブに移動し、左側のナビゲーションペインでテンプレート Payment Gateway / Show をクリックします。

{% when "stripe" %} で始まるコードブロックの後に以下のスニペットがまだ表示されていない場合には、スニペット追加します。

{% when "adyen12" %}
{% if current_account.has_billing_address? %}
  {% adyen12_form %}
{% else %}
  <p><a href="{{ current_account.edit_adyen12_billing_address_url }}">First add a billing address</a></p>
{% endif %}
注記
  • Adyen からのデータを 3scale のデータとマッピングするには、Adyen フィールド shopperReference を使用することができます (構成は 3scale-[PROVIDER_ID]-[DEVELOPER_ACCOUNT_ID])。

14.8.3. Braintree インテグレーション

API の使用に対する課金を行うために Braintree ゲートウェイを設定する手順を以下に示します。

14.8.3.1. Braintree からの API キーの取得

Braintree のアカウントを作成する必要があります。Gateway および Merchant アカウントならびに Vault が必要です。オプションとして、支払い方法として American Express カードを許可する選択が可能です。

まず初めに、Braintree アカウントにログインします。次に、Account > MyUser セクションでご自分の API キーを探します。

Braintree Settings

API キーのページではまだ秘密鍵は非表示の状態なので、表示するオプションを選択します。

Braintree keys

最終的に、公開鍵、秘密鍵、および業者 ID が得られます。これらの情報が 3scale の請求設定で必要です。

Braintree keys

14.8.3.2. 3scale 設定の定義

これらの API キーの使用を開始するように 3scale を設定する必要があります。そのためには、3scale 管理ポータルにログインし、Audience > Billing > Charging & Gateway の順に移動します。

請求のページで指定した通貨のタイプが、Braintree の業者アカウントで使用される通貨のタイプと一致するようにしてください。

Billing

Charging enabled のチェックボックスが選択されていない場合には、選択して Save をクリックします。

Billing charging enabled

ページ最下部近くの Gateway セクションに、ドロップダウンが表示されるはずです。それを Braintree (Blue Platform) に変更します。

Billing Gateway

ドロップダウンの下のフォームが変わり、2 つのフィールドが表示されるはずです。Braintree のキーを入力し、Save をクリックします。

Ogone billing gateway

支払いゲートウェイを変更すると、いくつかの警告が表示される場合があります。これは想定される状況です。表示されたら、警告を読んで了承してください。

これで、ユーザーは Braintree ゲートウェイを使用して費用を支払うことができるはずです。

注記

Braintree からのデータを 3scale のデータとマッピングするには、Braintree フィールド customer.id を使用することができます (構成は 3scale-[PROVIDER_ID]-[DEVELOPER_ACCOUNT_ID])。

14.8.3.2.1. トラブルシューティング

アカウントがサンドボックスモードにあり、何らかの問題が発生した場合には、実稼働モードに変更する必要があります。