Como configurar o URL do portal dos Serviços do desenvolvedor

Edge para nuvem privada v. 4.17.05

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

A IU 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 "false" para ativar o botão e como "true" para desativá-lo.
  • features.devportalUrl: defina como o URL do portal do desenvolvedor.

Você pode definir 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 formulário:

{
  "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 existentes 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 existentes quando configurá-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 definida originalmente na organização.