Как задать URL портала

Apigee предоставляет портал Apigee Developer Services (или просто портал), который можно использовать для создания и запуска собственного сайта, чтобы предоставлять все эти услуги сообществу разработчиков. Клиенты Edge могут создать собственный портал для разработчиков в облаке или локально. Подробнее о портале для разработчиков…

В новом интерфейсе Edge на странице Publish (Публикация) > Portals (Порталы) или Publish (Публикация) > Developers (Разработчики) есть кнопка DevPortal, при нажатии на которую открывается портал, связанный с организацией. По умолчанию эта кнопка открывает следующий URL:

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

где orgname – название организации.

Вы можете настроить URL портала для разработчиков на уровне организации, используя свойства организации, или настроить глобальный шаблон резервного URL в новом интерфейсе Edge.

Как задать URL портала для организации

Вы можете задать другой 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" : "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, которое изначально было задано для организации.

Как задать глобальный шаблон URL резервного портала в новом интерфейсе Edge

Если для организации не задано значение features.devportalUrl, интерфейс New Edge использует глобальный шаблон по умолчанию, определенный параметром conf_uebe_dev_portal_template (по умолчанию http://live-{org}.devportal.apigee.com, где {org} заменяется названием организации).

Чтобы изменить глобальный шаблон резервного URL в новом интерфейсе Edge:

  1. Откройте файл /opt/apigee/customer/application/management-ui.properties в редакторе. Если файла нет, создайте его:
    vi /opt/apigee/customer/application/management-ui.properties
  2. Задайте значение conf_uebe_dev_portal_template, используя {org} в качестве плейсхолдера для названия организации:
    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