ポータルの URL の設定

Edge for Private Cloud v4.19.01

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

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

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

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

たとえば、ポータルに DNS レコードがある場合は、別の 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 領域の既存のプロパティに注目してください。組織に関する "properties" を設定すると、"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" プロパティも含まれることに注意してください。