設定開發人員入口網站網址

Private Cloud 適用的 Edge 4.17.09 版

Apigee 提供 Developer Services 入口網站,方便您建構及推出自訂網站,為開發社群提供所有這些服務。Edge 客戶可以在雲端或地端部署環境中建立自己的開發人員入口網站。詳情請參閱「什麼是開發人員入口網站?」一文。

Edge UI 會在「發布」>「開發人員」頁面上顯示「DevPortal」按鈕,點選後會開啟與機構相關聯的入口網站。根據預設,這個按鈕會開啟下列網址:

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

其中 {orgname} 是機構名稱。

您可以將這個網址設為其他網址 (例如您的入口網站有 DNS 記錄),或是完全停用按鈕。使用機構的下列屬性控制按鈕:

  • features.devportalDisabled:將值設為 false (預設值) 可啟用按鈕,設為 true 則可停用按鈕。
  • features.devportalUrl:設為開發人員入口網站的網址。

您必須為每個機構組織分別設定這些屬性。如要設定這些屬性,請先使用下列 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」屬性。