Définir l'URL du portail des services pour les développeurs

Edge pour Private Cloud v4.18.01

Apigee vous fournit un portail de services pour les développeurs que vous pouvez utiliser pour créer et lancer votre propre site Web personnalisé pour fournir tous ces services à votre communauté de développement. Les clients Edge peuvent créer leur propre portail des développeurs, dans le cloud ou sur site. Consultez la section Qu'est-ce qu'un portail des développeurs ? pour découvrir plus d'informations.

L'interface utilisateur d'Edge affiche le bouton DevPortal sur la page Publier > Développeurs. Lorsque vous cliquez dessus, le portail associé à une organisation s'ouvre. Par défaut, ce bouton ouvre l'URL suivante :

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

où {orgname} est le nom de l'organisation.

Vous pouvez définir une autre URL, par exemple si votre portail dispose d'un enregistrement DNS. désactiver complètement le bouton. Utilisez les propriétés suivantes de l'organisation pour contrôler le bouton :

  • features.devportalDisabled : à définir sur "false" (par défaut) pour activer le bouton et sur "true" pour le désactiver.
  • features.devportalUrl: définir à l'URL du portail des développeurs.

Vous définissez ces propriétés séparément pour chaque organisation. Pour définir ces propriétés, vous devez d'abord utiliser l'appel d'API suivant pour déterminer les paramètres de propriété actuels de l'organisation :

curl -H "Content-Type:application/json" \
-u adminEmail:pword -X GET \
http://<ms-IP>:8080/v1/organizations/{orgname}

Cet appel renvoie un objet décrivant l'organisation sous la forme suivante:

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

Notez toutes les propriétés existantes dans la zone properties de l'objet. Lorsque vous définissez propriétés de l'organisation, sa valeur remplace toutes les propriétés actuelles. Par conséquent, si vous souhaitez définir features.devportalDisabled ou features.devportalUrl dans l'organisation, assurez-vous de copier toutes les propriétés existantes lorsque vous les définissez.

Utilisez l'appel PUT suivant pour définir des propriétés sur l'organisation :

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

Dans l'appel PUT, vous devez uniquement spécifier displayName, name et properties. Notez que cet appel inclut le paramètre "foo" définie à l'origine pour l'organisation.