Developer Services ポータルの URL の設定

Edge for Private Cloud v. 4.16.09

これらのすべてのサービスを開発コミュニティに提供するため、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 呼び出しで指定する必要があるのは、displayNamenameproperties のみです。この呼び出しには、組織に当初設定されていた "foo" プロパティも含めることに注意してください。