4.16.09 - Notes de version d'Edge for Private Cloud

Vous consultez la documentation Apigee Edge.
Accédez à la documentation Apigee X.

Le lundi 19 septembre 2016, nous avons lancé une nouvelle version d'Apigee Edge pour le cloud privé.

Depuis la précédente version de fonctionnalité Edge pour le cloud privé, les versions suivantes ont été publiées et sont incluses dans cette version de fonctionnalité :

• Cloud : 16.04.13 (UI), 16.04.13 (monetization), 16.04.20 (UI), 16.04.27 (monetization), 16.04.27 (UI), 16.05.04 (UI), 16.05.11 (UI), 16.05.11 (monetization), 16.05.18 (UI), 16.05.25 (monetization), 16.06.08 (monetization), 16.06.15 (UI), 16.06.22 (monetization), 16.06.29 (UI), 16.07.06 (monetization), 16.07.06.02 (monetization), 16.07.13 (UI), 16.07.20.01 (monetization), 16.07.27 (UI), 16.08.17

Consultez À propos de la numérotation des versions pour savoir comment déterminer si une version cloud spécifique est incluse dans votre version d'Edge for Private Cloud.

Présentation de la version

Dans cette version, l'éditeur de proxy d'API classique a été supprimé et remplacé par le nouvel éditeur de proxy, qui était disponible pour être utilisé en parallèle de l'éditeur classique. Parmi les autres améliorations notables, citons le comportement amélioré des chemins d'accès aux ressources des produits d'API, la gestion améliorée des charges utiles JSON définies dans les règles "Assign Message" et "Raise Fault", les améliorations apportées aux conversions XML vers JSON, la validation améliorée des ressources, la possibilité de définir des délais d'attente sur les proxys d'API individuels, la génération mise à jour des proxys SOAP dans l'assistant de proxy d'API et un objet Crypto hautes performances pour JavaScript.

Les améliorations apportées à la monétisation incluent de nouvelles fonctionnalités de notification avec un plan tarifaire de notification, une API qui permet aux développeurs de migrer vers la monétisation et la possibilité de rendre les plans tarifaires publics ou privés.

Le reste de cette rubrique contient des informations détaillées sur toutes les nouvelles fonctionnalités, mises à jour et corrections de bugs incluses dans la version.

Obsolète

Services d'API

Suppression de l'éditeur de proxy classique (interface utilisateur Cloud 16.04.20)

La nouvelle version de l'éditeur de proxys d'API est désormais la seule version acceptée. L'ancienne version n'est plus disponible et le lien "Accéder à l'ancienne version de l'éditeur de proxy" a été supprimé. Si vous utilisiez la version classique, vos proxys d'API seront automatiquement chargés dans le nouvel éditeur. (EDGEUI-498)

Monétisation

Les fonctionnalités obsolètes suivantes ont été supprimées et ne sont plus compatibles :

• Définir des limites
• Notifications de limite d'envoi

Vous pouvez également configurer des notifications, comme décrit dans les sections suivantes :

• Configurer les notifications d'événements
• Créer une notification de limite pour un plan tarifaire

(DEVRT-2742)

Nouvelles fonctionnalités et mises à jour

Voici les nouvelles fonctionnalités et améliorations apportées à cette version. En plus des améliorations suivantes, cette version contient également de nombreuses améliorations en termes d'usabilité, de performances, de sécurité et de stabilité.

Pour en savoir plus et obtenir des instructions, consultez la documentation Edge pour le cloud privé.

Cloud privé

Mise à niveau de Postgres vers la version 9.4

Cette version inclut une mise à niveau vers Postgres 9.4. Pour obtenir des instructions sur la mise à jour de votre système, consultez Mettre à jour Apigee Edge vers la version 4.16.09.

Compatibilité de GeoMap dans l'interface utilisateur Edge

Les agrégations géographiques vous permettent de collecter des données analytiques pour les appels d'API en fonction d'attributs géographiques tels que la région, le continent, le pays et la ville. À partir de ces données analytiques, vous pouvez afficher une carte géographique dans l'UI Edge qui indique la localisation des requêtes API.

Pour en savoir plus, consultez Activer l'agrégation géographique et les cartes géographiques.

API BaaS

Ajout de documentation sur :

• Comment configurer API BaaS pour utiliser TLS. Pour en savoir plus, consultez Configurer TLS pour API BaaS.
• Comment configurer tous les nœuds de la pile API BaaS pour qu'ils utilisent le stockage partagé afin que tous les composants soient disponibles pour tous les nœuds de la pile API BaaS. Pour en savoir plus, consultez Importer des composants.
• Comment chiffrer le mot de passe Cassandra lors de la configuration des nœuds de la pile BaaS Pour en savoir plus, consultez Réinitialiser les mots de passe Edge.

Version bêta de l'outil et du tableau de bord de surveillance

Cette version inclut une version bêta du nouvel outil de surveillance et du nouveau tableau de bord pour Edge. Cet outil vous permet de comprendre l'état de différents composants (routeurs, processeurs de messages, ZooKeeper, Cassandra), ainsi que les codes d'erreur HTTP pour différentes organisations et différents environnements de votre déploiement. Vous pouvez également prendre un instantané des données de votre tableau de bord et le partager avec Apigee pour vous aider à résoudre les incidents d'assistance.

La documentation, y compris les instructions d'installation, est incluse dans la documentation Edge 4.16.09 à la page Version 4.18.01.

Toutefois, avant de pouvoir installer et utiliser le tableau de bord, vous devez remplir le contrat d'évaluation Apigee, également disponible sur la page Version 4.18.01, et le renvoyer à Apigee par e-mail à l'adresse orders@apigee.com.

Version bêta de l'outil de collecte Analytics

Tous les clients Edge pour le cloud privé doivent envoyer à Apigee des statistiques sur le trafic des proxys d'API. Apigee recommande aux clients d'importer ces informations une fois par jour, éventuellement en créant une tâche Cron.

Pour vous aider à importer ces données, Apigee fournit la version bêta de l'utilitaire de ligne de commande apigee-analytics-collector. Cet utilitaire renvoie le rapport sur le volume d'appels d'API à Apigee. Chaque installation Edge pour le cloud privé peut utiliser cet utilitaire pour récupérer et signaler les données de trafic à Apigee.

Pour en savoir plus, consultez Importer des données de trafic d'API dans Apigee – Version bêta.

Services d'API

Charges utiles JSON dans les éléments "Assign Message" et "Raise Fault" (Cloud 16.08.17)

Grâce à cette amélioration, aucune solution de contournement n'est nécessaire pour garantir la mise en forme correcte des messages JSON. De plus, les variables peuvent être spécifiées à l'aide d'accolades sans créer de fichier JSON non valide. Par exemple, la commande suivante insère la valeur de message.content dans le message JSON :

<Payload contentType="application/json">{"Message: " : "{message.content}"}</Payload>

Si vous avez utilisé une solution de contournement, votre code continuera de fonctionner tel quel. Vous pouvez également utiliser variablePrefix et variableSuffix au lieu d'accolades pour indiquer les variables.

Consultez l'élément <Set><Payload> dans les documents de référence sur la règle AssignMessage et la règle RaiseFault. (APIRT-1160)

Améliorations apportées à la règle XML vers JSON (Cloud 16.08.17)

La règle XML vers JSON a été améliorée avec les fonctionnalités suivantes. Vous pouvez configurer la règle pour :

• Traitez certains éléments XML comme des tableaux lors de la conversion, ce qui place les valeurs entre crochets "[ ]" dans le document JSON.
• Supprime ou élimine des niveaux de la hiérarchie du document XML dans le document JSON final.

Pour en savoir plus, consultez Règle XML vers JSON. (APIRT-1144)

Plusieurs caractères génériques dans les chemins d'accès aux ressources de produits d'API (Cloud 16.08.17)

Lorsque vous définissez des chemins de ressources dans un produit d'API, vous pouvez inclure des caractères génériques à plusieurs endroits dans un chemin de ressource. Par exemple, /team/*/invoices/** autorise les appels d'API avec n'importe quelle valeur après /team et n'importe quel chemin de ressource après invoices/. Un URI autorisé lors d'un appel d'API serait proxyBasePath/team/finance/invoices/company/a.

Si, après cette version, les chemins d'accès aux ressources de vos produits API existants ne fonctionnent plus comme prévu, définissez la propriété suivante sur votre organisation pour revenir au comportement précédent : features.enableStandardWildCardMatchForAPIProductResources = true

(MGMT-3273)

Fonctions de chiffrement en JavaScript (Cloud 16.08.17)

Un nouvel ensemble de fonctions JavaScript crypto hautes performances est disponible pour créer, obtenir et mettre à jour les objets de hachage suivants : MD5, SHA-1, SHA256, SHA512. L'objet crypto vous permet également d'obtenir la date dans différents formats. Pour en savoir plus, consultez la page Modèle d'objet JavaScript. (APIRT-2886)

Vérification de la version JAR de l'appel Java (Cloud 16.08.17)

Lorsque vous importez une ressource JAR Java dans un proxy d'API, un code d'état HTTP 400 est renvoyé (au lieu de 500) si la version de la ressource Java n'est pas compatible avec la version de Java acceptée par Edge, listée dans Logiciels et versions compatibles. (MGMT-3420)

Validation des ressources de proxy d'API (Cloud 16.08.17)

Lorsque vous stockez des fichiers de ressources de proxy d'API (tels que des fichiers JAR JavaScript ou Java) au niveau de l'environnement ou de l'organisation, le framework de validation ne vous oblige plus à inclure également ces ressources au niveau du proxy d'API dans un bundle de proxy pour que l'importation soit validée. La validation des ressources a désormais lieu au moment du déploiement, et non de l'importation. (MGMT-1430)

Configurer le délai d'inactivité pour des proxy d'API individuels (Cloud 16.08.17)

Vous pouvez configurer des proxys d'API pour qu'ils expirent au bout d'une période spécifiée (avec un état 504 Gateway Timeout). Le principal cas d'utilisation est destiné aux clients de cloud privé qui disposent de proxys d'API dont l'exécution prend plus de temps. Par exemple, supposons que vous ayez besoin que des proxys spécifiques dépassent le délai au bout de trois minutes. Vous pouvez utiliser une nouvelle propriété api.timeout dans la configuration d'un proxy d'API. Voici comment procéder avec l'exemple de trois minutes :

1. Commencez par configurer l'équilibreur de charge, le routeur et le processeur de messages pour qu'ils dépassent le délai au bout de trois minutes.
2. Configurez ensuite les proxys concernés pour qu'ils dépassent le délai au bout de trois minutes. Spécifiez la valeur en millisecondes. Exemple :

   <ProxyEndpoint name="default">
     <HTTPProxyConnection>
       <BasePath>/v1/weather</BasePath>
       <Properties>
         <!-- api.timeout is in milliseconeds -->
         <Property name="api.timeout">180000</Property>
       </Properties>
       ...

3. Notez toutefois que l'augmentation des délais d'inactivité du système peut entraîner des problèmes de performances, car tous les proxys sans paramètre api.timeout utilisent les nouveaux délais d'inactivité plus élevés de l'équilibreur de charge, du routeur et du processeur de messages. Configurez donc d'autres proxys d'API qui ne nécessitent pas de délais d'inactivité plus longs afin d'utiliser des délais d'inactivité plus courts. Par exemple, la commande suivante définit le délai d'inactivité d'un proxy d'API au bout d'une minute :
   <Property name="api.timeout">60000</Property>

Les clients Cloud, qui ne peuvent pas modifier les délais d'inactivité Edge, peuvent également configurer un délai d'inactivité du proxy d'API, tant que ce délai est inférieur au délai d'inactivité du processeur de messages Edge standard de 57 secondes.

Vous ne pouvez pas remplir la valeur avec une variable. Cette propriété est décrite dans la documentation de référence sur les propriétés des points de terminaison. (APIRT-1778)

Comportement du proxy SOAP lors de l'utilisation de l'assistant de proxy (interface utilisateur Cloud 16.07.27)

Lorsque vous créez un proxy basé sur SOAP à partir d'un fichier WSDL à l'aide de l'assistant de création de proxy, deux options s'offrent à vous :

• SOAP direct, où le proxy transmet simplement une charge utile de requête SOAP telle quelle.
• REST vers SOAP vers REST, où le proxy convertit une charge utile entrante telle que JSON en charge utile SOAP, puis reconvertit la réponse SOAP au format attendu par l'appelant.

Cette version inclut les modifications suivantes concernant le comportement de ces options. Les différences entre l'ancien et le nouveau comportement se trouvent dans les règles et les configurations générées automatiquement par l'assistant de proxy.

SOAP Pass-Through

• Toutes les opérations WSDL sont désormais envoyées au chemin de base du proxy "/" plutôt qu'aux ressources du proxy (comme "/cityforecastbyzip"). Les noms d'opération sont transmis au service SOAP cible. Ce comportement correspond à la spécification SOAP.

• Le proxy généré ne prend plus en charge JSON dans la requête. Il n'accepte que le format XML. Le proxy s'assure que les requêtes SOAP comportent une enveloppe, un corps et un espace de noms.

REST à SOAP à REST

• WSDL 2.0 n'est pas accepté.
• Le nouveau comportement n'a pas été testé avec WS-Policy.
• Le proxy vous permet d'envoyer des données JSON au lieu de FormParams.
• Lorsque vous ajoutez la compatibilité CORS (Cross-Origin Resource Sharing) au proxy à l'aide du compilateur de proxy, vous bénéficiez des améliorations suivantes :
  • En-tête Access-Control-Allow-Headers : en plus des en-têtes Origin, x-requested-with et Accept, l'en-tête Access-Control-Allow-Headers inclut également Content-Type, Accept-Encoding, Accept-Language, Host, Pragma, Referrer, User-Agent et Cache-Control.
  • En-tête Access-Control-Allow-Methods : en plus de GET, PUT, POST et DELETE, cet en-tête inclut également les verbes PATCH et OPTIONS.
• Lors de la génération d'un proxy d'API pour un fichier WSDL, Edge lit tous les ComplexTypes définis comme abstraits dans le fichier WSDL et reconnaît correctement tous les types d'instances basés sur les types abstraits.

Utilitaire de ligne de commande Open Source wsdl2apigee

Apigee fournit également un utilitaire de ligne de commande Open Source permettant de générer des proxys d'API pass-through ou REST-to-SOAP à partir de WSDL. Consultez https://github.com/apigee/wsdl2apigee.

(EDGEUI-614)

Expiration/actualisation par défaut dans la règle des opérations de mappage de clés-valeurs (UI Cloud 16.06.15)

La règle des opérations de mappage clé-valeur vous permet de déterminer la durée de persistance des valeurs avant leur actualisation. L'intervalle d'actualisation est défini avec l'élément <ExpiryTimeInSecs>. Si une opération GET est exécutée et que l'intervalle d'expiration a été dépassé, la valeur est actualisée et la règle obtient la valeur mise à jour. Lorsque vous ajoutez cette règle à un proxy d'API, le délai d'expiration par défaut est désormais de 300 secondes. (La valeur par défaut précédente était -1, ce qui signifie que les valeurs ne sont jamais actualisées.) (EDGEUI-579)

Monétisation

Plan tarifaire avec taux de notification ajustable (interface utilisateur Cloud 16.04.20, monétisation Cloud 16.04.13)

Un nouveau forfait à taux de notification ajustable dans la monétisation Edge permet à un fournisseur d'API d'ajuster le nombre cible de transactions pour chaque développeur d'applications. Vous pouvez configurer l'envoi de notifications en fonction du pourcentage de l'objectif atteint (90 %, 100 % ou 150 %, par exemple). Cette fonctionnalité est disponible dans l'interface utilisateur de gestion, en plus de l'API Management (qui était disponible dans une version précédente). Pour en savoir plus, consultez Spécifier les détails d'un forfait de notifications ajustable. (DEVRT-2375, DEVRT-2370)

Notifications de webhook pour les forfaits à taux de notification ajustable (monétisation Cloud 16.04.27)

Pour les forfaits à taux de notification ajustable, vous pouvez créer des webhooks qui envoient des notifications à l'URL que vous spécifiez. Vous pouvez également contrôler les notifications pour qu'elles se produisent à des intervalles spécifiques (pourcentages) jusqu'à ce que la limite de transaction soit atteinte. Les notifications de webhook constituent une alternative flexible à l'utilisation des modèles de notification existants. Consultez Configurer les notifications à l'aide de webhooks. (DEVRT-2393, DEVRT-2394)

Forfait "Notification ajustable avec attribut personnalisé" (UI Cloud 16.05.18)

Dans la monétisation Edge, un nouveau forfait "Notification ajustable avec attribut personnalisé" vous permet d'ajouter au nombre de transactions d'un développeur en utilisant la valeur d'un attribut personnalisé. Avec le forfait standard à taux de notification ajustable, chaque appel d'API réussi ajoute 1 au nombre de transactions d'un développeur. Toutefois, avec le forfait "Notification ajustable avec attribut personnalisé", la valeur de l'attribut personnalisé est ajoutée au nombre de transactions du développeur. Par exemple, si l'attribut personnalisé "small" a une valeur de 0,1 dans la réponse, le nombre de transactions est incrémenté de 0,1. Si l'attribut personnalisé "addressTotal" a une valeur de 50, le nombre est incrémenté de 50. Pour en savoir plus, consultez Spécifier un forfait avec des détails d'attributs personnalisés. (DEVRT-2504)

Configurer des notifications basées sur le total combiné des transactions pour une entreprise et ses développeurs (monétisation Cloud 16.06.22)

En règle générale, les totaux des transactions sont suivis automatiquement pour tous les développeurs d'une entreprise lorsque ceux-ci utilisent l'application de l'entreprise pour accéder aux API. Que faire si des développeurs utilisent activement leurs propres applications de développement pour accéder aux API et que vous devez suivre le total combiné de leurs transactions sans interrompre le trafic ? Vous pouvez ajouter les développeurs à une entreprise et configurer l'envoi de notifications lorsque des seuils sont atteints, en fonction du total combiné des transactions pour l'entreprise et ses développeurs. Pour en savoir plus, consultez Configurer des notifications basées sur le total des transactions combinées pour une entreprise et ses développeurs. (DEVRT-2643)

Afficher et retraiter les notifications (monétisation Cloud 16.06.08)

Dans la suite de tests de monétisation, vous pouvez afficher et retraiter les notifications précédemment envoyées à l'aide de l'API Management. Pour en savoir plus, consultez Afficher et retraiter les notifications. (DEVRT-2643)

Test de monétisation (monétisation Cloud 16.05.25)

La monétisation fournit un ensemble d'API que vous pouvez utiliser pour tester l'exécution des Webhooks afin de vous assurer que les notifications sont envoyées. Pour en savoir plus, consultez Tester la configuration des notifications. (DEVRT-2625)

Migrer les développeurs vers la monétisation (monétisation Cloud 16.05.11)

Une nouvelle API est disponible pour faciliter la migration des développeurs vers la monétisation. Vous pouvez transférer l'utilisation des transactions et facturer des frais de configuration et récurrents personnalisés. De plus, lorsque vous acceptez un plan tarifaire publié, vous pouvez renoncer aux frais de configuration s'ils ont déjà été facturés. Pour en savoir plus, consultez Migrer les développeurs vers la monétisation. (DEVRT-2446)

Plans tarifaires publics et privés pour le portail des développeurs (monétisation Cloud 16.04.27)

Vous pouvez définir les plans tarifaires sur "Public" ou "Privé". Les plans tarifaires publics apparaissent dans le portail des développeurs, contrairement aux plans tarifaires privés. Par défaut, un plan tarifaire est défini sur "Public". Pour en savoir plus, consultez http://docs.apigee.com/monetization/content/create-rate-plans#public-versus-private-rate-plans. (DEVRT-2445)

Réactiver des comptes de développeurs (monétisation Cloud 16.06.08)

La monétisation fournit un ensemble d'API que vous pouvez utiliser pour réactiver un développeur qui a été suspendu. Un développeur peut être suspendu si une limite configurée est atteinte. Par exemple, le nombre de transactions a atteint sa limite maximale ou le solde d'un compte prépayé a été épuisé. Pour en savoir plus, consultez Réactiver des développeurs. (DEVRT-2641)

Afficher l'état des transactions (monétisation Cloud 16.06.08)

Dans la suite de tests de monétisation, vous pouvez afficher l'état des transactions qui ont eu lieu au cours d'une période spécifiée à l'aide de l'API Management. Pour en savoir plus, consultez Afficher l'état des transactions. (DEVRT-2640)

Inclure des attributs personnalisés de développeur dans les rapports sur les revenus (monétisation Cloud 16.05.25)

Pour les rapports sur les revenus uniquement, vous pouvez inclure des attributs personnalisés dans le rapport, si l'attribut personnalisé est défini pour le développeur. Pour en savoir plus, consultez Inclure des attributs personnalisés de développeur dans les rapports sur les revenus à l'aide de l'API. (DEVRT-2447)

Cohérence entre la règle d'enregistrement des transactions et la ressource du produit API (UI Cloud 16.05.18)

Si les chemins de ressources d'une règle d'enregistrement des transactions de monétisation ne correspondent pas à ceux définis dans son produit d'API (par exemple, si vous modifiez les chemins de ressources du produit d'API), l'icône de la règle d'enregistrement des transactions sur la page "Produits" affiche un symbole d'avertissement. Lorsque vous cliquez sur l'icône pour afficher le règlement sur l'enregistrement des transactions, un avertissement s'affiche en haut de la page. Lorsque vous corrigez les chemins d'accès aux ressources dans la règle d'enregistrement des transactions, les indicateurs d'avertissement disparaissent. (DEVRT-2240)

Bugs résolus

Les bugs suivants sont résolus dans cette version. Cette liste s'adresse principalement aux utilisateurs qui veulent vérifier si leurs demandes d'assistance ont été corrigées. Elle n'est pas conçue pour fournir des informations détaillées à tous les utilisateurs.

Edge pour le cloud privé

16.08.17

16.07.27 (UI)

16.07.20.01 (monétisation)

Cette version inclut des modifications mineures du schéma de base de données. Elle ne contient aucune autre mise à jour logicielle.

16.07.13 (UI)

16.07.06.02 (monetization)

16.07.06 (monetization)

16.06.29 (UI)

16.06.22 (monétisation)

Aucun

16.06.15 (UI)

16.06.08 (monétisation)

Aucun

16.05.25 (monétisation)

16.05.18 (UI)

16.05.11 (monétisation)

16.05.11 (UI)

16.05.04 (UI)

16.04.27 (UI)

16.04.27 (monétisation)

Aucun

16.04.20 (UI)

16.04.13 (monétisation)

Aucun

16.04.13 (UI)

Problèmes connus

Cette version présente les problèmes connus suivants :