手順

1. Dashboard に移動します。
2. APIS セクションで Products タブを選択します。
3. New Product をクリックします。

4. 以下の情報を指定します。

   • Name: プロダクトの識別子

   • System name: 内部での処理に使用される識別子。プロダクトの system_name を使用して、プロキシーエンドポイントおよびドメイン名が生成されます。デフォルトでは、system_name はラベルの一部で、ラベルのパターンは以下のどちらかになります。

     • ステージング環境用 APIcast の場合: %{system_name}-%{tenant_name}-apicast-staging
     • 実稼働環境用 APIcast の場合: %{system_name}-%{tenant_name}-apicast-production

     • 自動生成される URL ラベルが 63 文字を超えると、システムはラベルを <truncated-label>-<unique-hash> のように短縮します。

       • <truncated-label> は、元の URL の最初の 54 文字または 55 文字です。

       • <unique-hash> は、元のラベルから計算された一意の SHA-1 ハッシュの最初の 7 文字です。

         たとえば、省略される前の URL が以下であった場合、

         https://my-very-long-system-name-also-very-long-tenant-name-apicast-staging.3scale.net

         省略後の URL は以下のようになります。

         https://my-very-long-system-name-also-very-long-tenant-name-api-72588d2.3scale.net

   • Description: プロダクトに関するより詳しい情報を記述するオプションフィールド
5. Create Product をクリックします。

手順

1. Dashboard に移動します。
2. APIS セクションで Backends タブを選択します。
3. New Backend をクリックします。

4. 以下の情報を指定します。

   • Name: バックエンドの識別子
   • System name: 内部での処理に使用される識別子
   • Description: バックエンドに関するより詳しい情報を記述するオプションフィールド
   • Private endpoint: プライベート API のベース URL
5. Create Backend をクリックします。

手順

1. Dashboard の [Your_product_name] から、Integration > Backends の順に移動します。
2. Add Backend をクリックします。
3. ドロップダウンリストから既存のバックエンドを選択します。
4. Path テキストボックスでルーティングパスを指定します。詳細については、バックエンドパス を参照してください。
5. Add to Product をクリックします。

1. アプリケーションがリクエストを送信する。
2. リクエストが公開 URL <public-api-domain>/supplies/list に送信される。
3. プライベート URL <private-api-domain>/list にリダイレクトする前に、バックエンドパスが削除される。
4. リクエストが Inventory バックエンドにリダイレクトされる。

手順

1. Dashboard から Backends タブを選択します。
2. 設定を行うバックエンドの名前をクリックします。たとえば、API Backend をクリックします。
3. バックエンドについての詳細が表示されるページで、Mapping Rules に移動します。
4. Add Mapping Rule をクリックします。

5. 以下の設定を指定します。

   • Verb: HTTP リクエストの動詞 (GET、POST、DELETE、または PUT)
   • Pattern: 照合するパターン。たとえば、/hello 等。
   • Metric or method to increment: メトリクスまたはメソッドの名前
   • Increment by: メトリクスのカウントを増やす数。たとえば、1 等。
   • Last?: このマッピングルールを最後のルールとして、他のマッピングルールの処理を停止するかどうかを定義します。
   • Position: マッピングルール実行の順番を表す数字。マッピングルールの並べ替えに使用します。
6. Create Mapping Rule をクリックします。

1. [Your_product_name] > Applications > Application Plans の順に移動します。
2. Create Application Plan をクリックします。

3. Create Application Plan のページで、新しいプランの名前およびシステム名を入力します。

   • システム名は一意でなければなりません。
4. Create Application Plan をクリックします。

手順

1. Dashboard > Audience > Account の順に移動します。
2. Developer というデフォルトアカウントをクリックします。
3. Application タブに移動します。
4. Create Application をクリックします。
5. アプリケーションプランを選択します。
6. 名前および説明を指定します。
7. Create Application をクリックします。

手順

1. [Your_product_name] > Integration > Configuration の順に移動して、APIcast 設定をステージング環境にプロモートします。

2. APIcast Configuration セクションに、プロダクトに追加された各バックエンドのマッピングルールが表示されます。Promote v.[n] to Staging APIcast をクリックします。

   • v.[n] は、プロモート先のバージョン番号を表します。

3. ステージング環境にプロモートしたら、実稼働環境にプロモートすることができます。Staging APIcast セクションで、Promote v.[n] to Production APIcast をクリックします。

   • v.[n] は、プロモート先のバージョン番号を表します。

4. コマンドラインで API へのリクエストをテストするには、Example curl for testing で提供されるコマンドを使用します。

   • curl コマンドの例は、プロダクトの最初のマッピングルールに基づいています。

1. プロダクトにアクセス可能であることを確認します。(例: https://echo-api.3scale.net/v1/fast/track)。

   • セキュリティーレイヤー実装後は、バックエンドホストを隠したりアクセスを制限したりすることができます。
2. [Your_product_name] > Integration > Configuration の順に移動します。
3. [Your_product_name] について、プライベートエンドポイントがデフォルトの API Backend に設定されていることを確認します。たとえば、https://echo-api.3scale.net:443。
4. ボタンをクリックして、ステージング環境にプロモートします。

5. デフォルトクレデンシャルとして user_key が含まれる cURL ステートメントをコピーして、コマンドラインから呼び出しを行います。

   curl "https://api-2445581407825.staging.apicast.io:443/v1/fast/track?user_key=287d64924e6120d215b1000ac07c063b"

   異なる呼び出しを行うことができます。たとえば、同じ user_key を追加して、別のエンドポイントに対する呼び出しを行います。

   注記

   いずれかの開発者アカウントにあるアプリケーションの詳細ページから、API プロダクトキーを取得することができます。

   3scale のアクセス制御レイヤーにより、認証された呼び出しだけがご自分のバックエンド API にアクセスできるようになります。

1. [Your_product_name] > Applications > Application Plans の順に移動します。
2. Application plans セクションで Basic アプリケーションプランに進み、3scale のインストールまたはサインアップ後にサンプルデータから生成されたプランのいずれかを編集します。
3. Metrics, Methods, Limits & Pricing Rules セクションで、Hits 行の Limits を選択し、1 時間あたり 3 回の新しい使用限度を作成します。
4. [Your_product_name] > Applications > Listing の順に移動し、サンプルアプリケーションを 1 つ選択します。アプリケーションが Basic プランに設定されていることを確認します。設定されていなければ、アプリケーションの詳細ページで プランを変更します。
5. このアプリケーションのクレデンシャルを使用して、上記のサンプルコールを少なくとも 3 回繰り返します。

1. 管理ポータルから Audience セクションに移動し、Developer Portal メニューの Visit Portal のリンクをクリックします。
2. テストサインアップを作成し、すべての手順を実施します。
3. 通常、セルフサービスはデフォルトで有効になっています。この設定を変更するには、Audience > Accounts > Usage Rules の順に移動し、Account approval required のチェックボックスを選択します。
4. テストサインアップの手順をすべて繰り返し、ユーザーがログインするには管理ポータルでアカウントを承認しなければならないことを確認します。

1. 管理ポータルへの初回ログイン後に、導入ウィザードの手順に従います。
2. 実稼働環境に適したバージョンが得られるまで、アクセスポリシーの調整などのプロダクト設定を繰り返します。
3. APIcast 設定を実稼働環境用ゲートウェイにプロモートします。

1. OpenShift サーバー上に、API ゲートウェイのテスト用システムを設定します。
2. 実稼働環境に適したバージョンが得られるまで、API 設定を繰り返します (アクセスポリシーの調整など)。
3. APIcast 設定を実稼働環境用ゲートウェイにプロモートします。
4. Self-managed APIcast の詳細な情報は、3scale のインストールの APIcast のインストール を参照してください。また、API ゲートウェイの管理の APIcast ポリシー には、API のアクセスポリシーを設定する際の概念が記載されています。

1. 操作対象のプロダクトを選択します。
2. Application Plans セクションで Basic を選択し、3scale へのサインアップまたはインスタンスのデプロイ後に自動的に生成されたプランのいずれかを編集します。
3. Hits に流量制御が設定されている場合には、その設定を削除します。
4. プランの Hits メトリックに 新規メソッド を追加し、システム名を test に設定します。
5. test メソッドの流量制御を 1 時間あたり 5 回に設定します。
6. 2 つの 新規メトリクス を追加し、システム名を v1 および v2 に設定します。
7. v2 メトリックの Enabled 列をクリックし、アクセスを無効にします。これは、流量制御をゼロに設定するのと同じ効果を持ちます。

1. [Your_product_name] > Integration > Configuration の順に移動します。

2. MAPPING RULES セクションを展開し、以下のマッピングを追加します。

   
   注記

   /のデフォルトのマッピングは削除されています。このデフォルトマッピングを使用すると、ヒット数が二重にカウントされます。

1. 3scale の承認およびレポート呼び出しにカスタムメソッドおよびメトリクスの使用状況を追加するには、プラグインライブラリーの手順および例に従ってください。
2. URL 構造からカスタムメソッド test へのマッピングを確認します。
3. URL からカスタムメトリクス v1 および v2 へのマッピングを確認します。

4. 3scale の Basic プランに関連付けられたアプリケーションのクレデンシャルを使用して、呼び出しをテストします。

   • 呼び出しは許可されます。

     curl "https://api-2445581407825.staging.apicast.io:443/v1/test?user_key=287d64924e6120d215b1000ac07c063b"

     5 回目以降は、呼び出しが拒否されます。これは、test メソッドに設定した制限のためです。

   • 3scale の Basic プランでは v2 は許可されないので、呼び出しは拒否されます。

     curl "https://api-2445581407825.staging.apicast.io:443/v2/test?user_key=287d64924e6120d215b1000ac07c063b"

   • missing に設定されたマッピングルールがないので、呼び出しは拒否されます。

     curl "https://api-2445581407825.staging.apicast.io:443/missing?user_key=287d64924e6120d215b1000ac07c063b"

   • プラグインのマッピングの実装状態によっては、これらの呼び出しは NGINX に対して許可されます。以下の呼び出しで 404 not found のレスポンスが返されるかどうかは、お使いのアプリケーションによります。これを避けるには、マッピングを調整してください。

     curl "https://api-2445581407825.staging.apicast.io:443/noversion/test?user_key=287d64924e6120d215b1000ac07c063b"

1. API Settings のページに移動します ([Your_product_name] > Integration > Settings)。
2. ページの ALERTS セクションに移動します。ここで、必要なアラートを流量制御値のパーセンテージで設定することができます。