ポータルの URL の設定

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

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

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

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

ポータルに DNS レコードがある場合などは、この 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" : "organme",
  "properties" : {
    "property" : [ {
      "name" : "foo",
      "value" : "bar"
    } ]
  },
  "type" : "paid"
}

オブジェクトの 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 呼び出しでは、displayNamenameproperties を指定するだけで済みます。この呼び出しには、組織に設定された「foo」プロパティも含まれます。