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

Edge for Private Cloud v4.18.01

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

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

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

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

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

  • 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.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, которое изначально было задано для организации.