设置门户的网址

Apigee 为您提供了 Apigee 开发者服务门户(或简称为“门户”),您可以使用该门户构建和启动自己的 自定义网站,以便向您的开发者社区提供所有这些服务。Edge 客户可以在云端或本地创建自己的开发者门户。如需了解详情,请参阅什么是开发者门户?

新版 Edge 界面会在 发布 > 门户 (或 发布 > 开发者 )页面上显示 DevPortal 按钮,点击该按钮即可打开与组织关联的 门户。默认情况下,该按钮会打开以下网址:

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

其中,orgname 是组织的名称。

您可以使用组织 属性在组织级配置开发者门户网址,也可以在新版 Edge 界面中配置全局后备网址模板。

为组织设置门户网址

您可以为特定组织将门户网址设置为其他网址,也可以通过在组织中设置以下属性来完全停用该 按钮:

  • 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" : "orgname",
  "properties" : {
    "property" : [ {
      "name" : "foo",
      "value" : "bar"
    } ]
  },
  "type" : "paid"
}

请注意该对象的 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 属性。

在新版 Edge 界面中设置全局后备门户网址模板

如果未在组织中设置 features.devportalUrl,新版 Edge 界面会使用 conf_uebe_dev_portal_template 定义的全局后备模板(默认值为 http://live-{org}.devportal.apigee.com,其中 {org} 会替换为 组织名称)。

如需在新版 Edge 界面中更改全局后备网址模板,请执行以下操作:

  1. 在编辑器中打开 /opt/apigee/customer/application/management-ui.properties。 如果该文件不存在,请创建它:
    vi /opt/apigee/customer/application/management-ui.properties
  2. 使用 {org} 作为组织名称的占位符来设置 conf_uebe_dev_portal_template:
    conf_uebe_dev_portal_template="https://portal.mycompany.com/{org}"
  3. 保存所做的更改,并确保该文件归 apigee 用户所有:
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  4. 重启新版 Edge 界面:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart