Définir l'URL du portail

Apigee vous fournit le portail Apigee Developer Services (ou simplement le portail), que vous pouvez utiliser pour créer et lancer votre propre site Web personnalisé afin de 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. Pour en savoir plus, consultez Qu'est-ce qu'un portail des développeurs ? pour

La nouvelle interface utilisateur Edge affiche le bouton DevPortal sur la page Publier > Portails (ou 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 configurer l'URL du portail des développeurs au niveau de l'organisation à l'aide des propriétés de l'organisation ou configurer un modèle d'URL de remplacement global dans la nouvelle interface utilisateur Edge.

Définir l'URL du portail pour une organisation

Vous pouvez définir l'URL du portail sur une autre URL pour une organisation spécifique ou désactiver complètement le bouton en définissant les propriétés suivantes pour l'organisation :

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

Vous définissez ces propriétés séparément pour chaque organisation. Pour définir ces propriétés, utilisez d'abord l'appel d'API suivant afin de 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" : "orgname",
  "properties" : {
    "property" : [ {
      "name" : "foo",
      "value" : "bar"
    } ]
  },
  "type" : "paid"
}

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

Utilisez l'appel PUT suivant pour définir des propriétés pour 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 n'avez qu'à spécifier displayName, name, et properties. Notez que cet appel inclut la foo propriété qui a été initialement définie pour l'organisation.

Définir un modèle d'URL de portail de remplacement global dans la nouvelle interface utilisateur Edge

Si features.devportalUrl n'est pas défini pour une organisation, la nouvelle interface utilisateur Edge utilise le modèle de remplacement global défini par conf_uebe_dev_portal_template (qui est défini par défaut sur http://live-{org}.devportal.apigee.com, où {org} est remplacé par le nom de l'organisation).

Pour modifier le modèle d'URL de remplacement global dans la nouvelle interface utilisateur Edge :

  1. Ouvrez /opt/apigee/customer/application/management-ui.properties dans un éditeur. Si le fichier n'existe pas, créez-le :
    vi /opt/apigee/customer/application/management-ui.properties
  2. Définissez conf_uebe_dev_portal_template en utilisant {org} comme espace réservé pour le nom de l'organisation :
    conf_uebe_dev_portal_template="https://portal.mycompany.com/{org}"
  3. Enregistrez vos modifications et assurez-vous que le fichier appartient à l'utilisateur apigee :
    chown apigee:apigee /opt/apigee/customer/application/management-ui.properties
  4. Redémarrez la nouvelle interface utilisateur Edge :
    /opt/apigee/apigee-service/bin/apigee-service edge-management-ui restart