Como configurar o URL do portal

Edge para nuvem privada v4.19.01

A Apigee oferece o portal de serviços para desenvolvedores da Apigee (ou simplesmente o portal) que pode ser usado para criar e lançar seu próprio site personalizado e fornecer todos esses serviços à comunidade de desenvolvimento. Os clientes do Edge podem criar o próprio portal do desenvolvedor, seja na nuvem ou no local. Consulte O que é um portal do desenvolvedor? para mais informações.

A interface do Edge exibe o botão DevPortal na página Publicar > Desenvolvedores que, quando clicado, abre o portal associado a uma organização. Por padrão, esse botão abre o seguinte URL:

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

Em que orgname é o nome da organização.

É possível definir esse URL como um URL diferente, por exemplo, se o portal tiver um registro DNS, ou desativar o botão completamente. Use as seguintes propriedades da organização para controlar o botão:

• features.devportalDisabled: defina como falso (padrão) para ativar o botão e como verdadeiro para desativá-lo.
• features.devportalUrl: defina como o URL do portal do desenvolvedor.

Defina essas propriedades separadamente para cada organização. Para definir essas propriedades, primeiro use a seguinte chamada de API para determinar as configurações de propriedade atuais na organização:

curl -H "Content-Type:application/json" -u adminEmail:pword -X GET \
  http://ms_IP:8080/v1/organizations/orgname

Essa chamada retorna um objeto que descreve a organização no formato:

{
  "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"
}

Observe as propriedades na área properties do objeto. Quando você define propriedades na organização, o valor delas substitui as propriedades atuais. Portanto, se você quiser definir features.devportalDisabled ou features.devportalUrl na organização, copie as propriedades atuais ao defini-las.

Use a seguinte chamada PUT para definir propriedades na organização:

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"
        }
      ]
    }
  }'

Na chamada PUT, basta especificar displayName, name e properties. Observe que essa chamada inclui a propriedade "foo" que foi originalmente definida na organização.