ポータルの URL の設定

Edge for Private Cloud v4.19.01

カスタマイズされた独自の Web サイトの構築、公開に際して、必要なすべてのサービスを開発コミュニティに提供するため、Apigee は Apigee Developer Services ポータル(ポータルともいう)を提供しています。Edge のお客様は、クラウドまたはオンプレミスで独自のデベロッパー ポータルを作成できます。詳細については、デベロッパー ポータルとはをご覧ください。

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

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

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

この URL は、たとえばポータルに 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 領域にある既存のプロパティに注意します。組織のプロパティを設定すると、プロパティの値によって現在のプロパティが上書きされます。そのため、組織の features.devportalDisabledfeatures.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」プロパティも含まれるので注意してください。