第1章 3scale 管理の API 用開発者ポータル作成の概要


3scale 開発者ポータルは、アプリケーションプログラミングインターフェイス (API) 利用者が使用する Web サイトです。

  • お客様の 3scale 管理のアップストリーム API にアクセスするためにサインアップする
  • お客様のアップストリーム API の使用方法に関するドキュメントを参照する

3scale が提供する開発者ポータルのサンプルには、ほとんどの API プロバイダーが開発者ポータルに実装する必要のある機能が含まれます。このネイティブ開発者ポータルでは、サンプルの Echo API を使用して、一般的な開発者ポータルの構造を実証します。ネイティブ開発者ポータルの確認後、ポータルを変更するための手順が記載されているので、独自の開発者ポータルの作成方法を理解することができます。

ネイティブ開発者ポータルの確認および変更の前提条件はありません。ただし、ネイティブの開発者ポータルを変更して独自の開発者ポータルを作成したら、開発者ポータルを API 利用者に公開する前に、サインインワークフローおよび認証も実装する必要があります。

1.1. 開発者ポータル作成用の 3scale API Management 編集環境の確認

開発者ポータルの作成を開始する前に、3scale で提供されるサンプルの Echo API 開発者ポータルを確認してください。Echo API 開発者ポータルは、専用の開発者ポータルを作成するための開始点となります。開発者ポータルはゼロから作成しません。代わりに、ネイティブの Echo API 開発者ポータルを変更して、希望のルックアンドフィールの開発者ポータルを作成します。

手順

  1. 3scale 管理ポータルで、上部のコンテキストセレクターをデプロイメントし、Audience をクリックします。
  2. 左側のナビゲーションツリーで Developer Portal をデプロイメントし、Content をクリックします。これにより、開発者ポータルを作成するためのメインの編集環境が表示されます。

    3scale では、Root に、開発者ポータルのリソース階層が表示されます。

    1. DocumentationHomepage、および Show は、開発者ポータルの基盤ページです。各ページでスクロールダウンし、ページコンテンツを定義する HTML を表示します。
    2. これらのページより下のフォルダーには、3scale リソースを開発者ポータルにプルするページが含まれます。たとえば、Account フォルダーには、3scale 管理者が管理ポータルで作成した 3scale アカウントを表示および編集するページが含まれます。これらのページを開始点として使用し、必要に応じて変更します。
    3. 右上の New Page ドロップダウンでは、ページ、レイアウト、パーシャル、セクション、ファイル、またはポートレットを追加できます。それぞれの項目を選択して、作成するために指定する情報を表示します。
  3. Developer Portal > Content を選択し、Layouts が表示されるまでリソースの階層をほぼ最下部までスクロールし、Main layout をクリックします。
  4. Layout 'Main Layout' の見出しが表示されるように、上方向にスクロールします。

    内部タイトルとシステム名の後に、Liquid が有効になっていることを確認できます。Liquid は、3scale が 3scale システムからのほとんどのデータを表示および処理するのに使用するフレームワークです。ページコンテンツを定義するコードには、Liquid マークアップと HTML が含まれます。これは Draft タブに表示されます。これには、開発者ポータルページのメインレイアウトのコードが含まれています。

  5. 左側のナビゲーションツリーで、Developer Portal > Content の下にある各サブカテゴリーを順番にクリックして確認します (DraftsRedirectsGroupsLogoFeature Visibility、および ActiveDocs)。
  6. 左側のナビゲーションツリーで、Developer Portal の下にある Visit Portal (最後のエントリー) をクリックします。

    新しいブラウザータブに、3scale が提供する Echo API 開発者ポータルの開発バージョンの Web サイトが表示されます。この開発バージョンを使用して、3scale ネイティブ開発者ポータルを表示します。その後、ネイティブ開発者ポータルのカスタマイズを繰り返し、加えた変更を表示して、独自の開発者ポータルを作成することができます。

    最上部に Draft|Published と書かれた濃いグレーのパネルが右側にあるので、これが開発者ポータルの開発バージョンであることが確認できます。Draft ビューは、反復/差分の改善をサポートします。Draft バージョンの見栄えおよび動作が希望どおりになったら、公開できます。

    右側のパネルには、現在のページのコンテンツを提供する要素がリスト表示されます。

    1. Page Homepage
    2. Layout Main layout
    3. Partial Submenu
    4. Partial analytics
  7. Page Homepage をクリックします。新しいブラウザータブに、編集するために Page 'Homepage' が開いている開発者ポータルの編集環境が表示されます。
  8. Echo API 開発者ポータルの開発バージョンに戻り、右上の SIGN IN をクリックすると、API 利用者が開発者ポータルにサインインするために使用する SIGN IN ページが表示されます。

    右側のグレーのパネルのテンプレートリストの下に、ユーザー名およびパスワードがあります。これを使用して、開発者ポータルへのサインインをシミュレーションできます。

    1. SIGN IN ページの USERNAME OR EMAIL フィールドに John を入力します。これは、右側のグレーパネルにリスト表示されるユーザー名です。
    2. PASSWORD フィールドに、グレーのパネルにリスト表示されるパスワードである 123456 を入力します。
    3. Sign In をクリックし、API 利用者に表示される開発者ポータルを表示します。

次のステップ

引き続き、十分にネイティブ開発者ポータルを確認してください。編集環境や、Echo API 開発者ポータルの開発バージョンの操作に慣れたら、3scale ネイティブ開発者ポータルの変更 の手順に従います。

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat