ポータルの URL の設定

Apigee には、Apigee Developer Services ポータル(略して「ポータル」)が用意されています。これを使用して、独自のカスタマイズされたウェブサイトを構築して立ち上げ、これらのサービスをすべて開発コミュニティに提供できます。Edge をご利用のお客様は、クラウドまたはオンプレミスで独自のデベロッパー ポータルを作成できます。詳細については、デベロッパー ポータルとはをご覧ください。

新しい Edge UI の [Publish] > [Portals](または [Publish] > [Developers])ページには、[DevPortal] ボタンが表示されます。このボタンをクリックすると、組織に関連付けられたポータルが開きます。デフォルトでは、このボタンをクリックすると次の URL が開きます。

http://live-orgname.devportal.apigee.com

ここで orgname は組織の名前です。

デベロッパー ポータル URL は、組織プロパティを使用して組織レベルで構成するか、New Edge UI でグローバル代替 URL テンプレートを構成できます。

組織のポータル URL を設定する

組織で次のプロパティを設定することで、特定の組織のポータル URL を別の URL に設定したり、ボタンを完全に無効にしたりできます。

  • features.devportalDisabled: ボタンを有効にするには false(デフォルト)に設定し、無効にするには true に設定します。
  • features.devportalUrl: 組織のデベロッパー ポータルの URL に設定します。

これらのプロパティは、組織ごとに個別に設定します。これらのプロパティを設定するには、まず次の API 呼び出しを使用して、組織の現在のプロパティ設定を確認します。

curl -H "Content-Type:application/json" -u adminEmail:pword -X GET \
  http://ms_IP:8080/v1/organizations/orgname

この呼び出しは、次の形式で組織を記述するオブジェクトを返します。

{
  "createdAt" : 1428676711119,
  "createdBy" : "me@my.com",
  "displayName" : "orgname",
  "environments" : [ "prod" ],
  "lastModifiedAt" : 1428692717222,
  "lastModifiedBy" : "me@my.com",
  "name" : "orgname",
  "properties" : {
    "property" : [ {
      "name" : "foo",
      "value" : "bar"
    } ]
  },
  "type" : "paid"
}

オブジェクトの properties 領域にある既存のプロパティをメモします。組織にプロパティを設定すると、properties の値によって現在のプロパティが上書きされます。したがって、組織で features.devportalDisabled または features.devportalUrl を設定する場合は、設定時に既存のプロパティをコピーしてください。

次の PUT 呼び出しを使用して、組織のプロパティを設定します。

curl -H "Content-Type:application/json" -u adminEmail:pword -X PUT \
  http://ms_IP:8080/v1/organizations/orgname \
  -d '{
    "displayName" : "orgname",
    "name" : "orgname",
    "properties" : {
      "property" : [
        {
          "name" : "foo",
          "value" : "bar"
        },
        {
          "name": "features.devportalUrl",
          "value": "http://dev-orgname.devportal.apigee.com/"
        },
        {
          "name": "features.devportalDisabled",
          "value": "false"
        }
      ]
    }
  }'

PUT 呼び出しでは、displayName、name、properties のみを指定する必要があります。この呼び出しには、組織に最初に設定された foo プロパティが含まれています。

新しい Edge UI でグローバル フォールバック ポータル URL テンプレートを設定する

組織に features.devportalUrl が設定されていない場合、新しい Edge UI は conf_uebe_dev_portal_template で定義されたグローバル フォールバック テンプレートを使用します(デフォルトは http://live-{org}.devportal.apigee.com で、{org} は組織名に置き換えられます)。

新しい Edge UI でグローバル代替 URL テンプレートを変更するには:

  1. エディタで /opt/apigee/customer/application/management-ui.properties を開きます。ファイルが存在しない場合は作成します。
    vi /opt/apigee/customer/application/management-ui.properties
  2. 組織名のプレースホルダとして {org} を使用して conf_uebe_dev_portal_template を設定します。
    conf_uebe_dev_portal_template="https://portal.mycompany.com/{org}"
  3. 変更を保存し、ファイルのオーナーが apigee ユーザーであることを確認します。
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  4. 新しい Edge UI を再起動します。
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart