Après avoir initialement créé un produit brouillon, vous pouvez poursuivre la configuration du produit
ou bien effectuer des modifications de configuration ultérieurement.
A propos de cette tâche
Vous pouvez effectuer cette tâche soit à l'aide de l'application d'interface utilisateur API Designer , soit à l'aide de l'interface utilisateur API Manager basée sur un navigateur.
Lors de la création initiale d'un produit, l'assistant vous guide afin que vous indiquiez les paramètres de configuration minimale,
puis fournit un bouton Editer le produit. Vous avez la possibilité de spécifier
immédiatement une configuration supplémentaire ou de revenir au produit ultérieurement pour l'éditer. Cette rubrique décrit la manière de spécifier une configuration supplémentaire dans l'un ou l'autre de ces cas.
Procédure
Pour éditer un produit brouillon, procédez comme suit :
- Accédez à la page Configuration du produit de l'une des manières suivantes:
- Une fois la création initiale du produit terminée, cliquez sur Editer le produit.
- Dans le panneau de navigation, cliquez sur Développement, puis sélectionnez l'onglet Produits.
- Cliquez sur l'intitulé du produit à éditer.
- Sur la page Configuration du produit, vous pouvez effectuer les modifications suivantes :
- Dans la section Infos , modifiez le Titre, Versionou Récapitulatif.
- Utilisez les sections Contact, Conditions de serviceet Licence pour entrer les détails correspondants selon les besoins.
- Changer le type de passerelle. Pour plus d'informations, consultez la API Connect section « Types de passerelle » et « Spécification du type de passerelle pour un produit ».
- Cliquez sur Sauvegarder pour sauvegarder vos modifications.
- Facultatif : indiquez les métadonnées du produit à afficher avec celui-ci dans le catalogue client :
- Cliquez sur l'onglet Source pour afficher la source OpenAPI du produit.
- Ajoutez l'attribut personnalisé
x-name:
value dans la section info . Par exemple : info:
version: 1.0.0
title: Multi Plans
name: multi-plans
x-customarg: This is the custom value
...
Où
customarg est le nom des métadonnées personnalisées et
This is the custom value est le contenu des informations.
- Cliquez sur Sauvegarder.
Lorsque le produit est publié dans le
catalogue grand public, les métadonnées personnalisées s'affichent avec le produit. Par exemple :
- Cliquez sur Visibilité, puis effectuez les changements selon vos besoins.
- Dans la section Visibilité , indiquez les utilisateurs auxquels le produit doit être visible. Vous pouvez choisir Public pour que le produit soit visible
par tous les utilisateurs, Authentifié pour que le produit soit à la disposition des utilisateurs qui ont été
correctement authentifiés ou Personnalisé pour spécifier les organisations de type consommateur
et les groupes d'organisations de type consommateur pour lesquels vous souhaitez que le
produit soit visible.
Si vous sélectionnez
Personnalisé, procédez comme suit:
- Sélectionnez le catalogue pour lequel vous souhaitez contrôler la visibilité.
- Utilisez la zone Rechercher des organisations et des groupes pour rechercher les organisations de type consommateur et les groupes d'organisations de type consommateur, dans le catalogue sélectionné, pour lesquels vous souhaitez que le produit soit visible. Si nécessaire, vous pouvez saisir le nom d'une association de consommateurs ou d'un groupe d'associations qui n'existe pas encore, mais qui sera ajouté ultérieurement. Créez-le ensuite en utilisant le même nom. Pour plus d'informations sur la création et la gestion des organisations de type consommateur et des groupes d'organisations de type consommateur, voir Administration des organisations de type consommateur.
- Dans la section Abonnabilité , indiquez les utilisateurs qui peuvent s'abonner aux plans dans le produit. Vous pouvez choisir Authentifié pour rendre les plans du produit abonnables par les utilisateurs qui se sont authentifiés, ou Personnalisé pour spécifier les organisations de type consommateur et les groupes d'organisations de type consommateur qui peuvent s'abonner aux plans du produit.
Si vous sélectionnez
Personnalisé, procédez comme suit:
- Sélectionnez le catalogue pour lequel vous souhaitez contrôler la possibilité d'abonnement.
- Utilisez la zone Rechercher des organisations et des groupes pour rechercher les organisations de type consommateur et les groupes d'organisations de type consommateur, dans le catalogue sélectionné, auxquels vous souhaitez que le produit puisse s'abonner. Si nécessaire, vous pouvez saisir le nom d'une association de consommateurs ou d'un groupe d'associations qui n'existe pas encore, mais qui sera ajouté ultérieurement. Créez-le ensuite en utilisant le même nom. Pour plus d'informations sur la création et la gestion des organisations de type consommateur et des groupes d'organisations de type consommateur, voir Administration des organisations de type consommateur.
Remarque :
- Si vous sélectionnez une visibilité ou une possibilité d'abonnement personnalisée, seuls 10 résultats de recherche s'affichent dans la liste de sélection pour les organisations de type consommateur et les groupes d'organisations de type consommateur. Si nécessaire, entrez une chaîne de recherche plus spécifique pour affiner la recherche.
- Bien que le titre de chaque organisation ou groupe soit affiché, suivi du nom entre parenthèses, seul le nom est affiché dans le tableau des organisations et groupes sélectionnés.
- Cliquez sur Sauvegarder pour sauvegarder vos modifications.
- Pour spécifier les API que vous souhaitez inclure dans le produit, cliquez sur API, puis procédez comme suit:
- Cliquez sur Editer.
Toutes les API brouillons sont répertoriées.
- Sélectionnez les API à inclure. Pour la mise en production, vous ne pouvez inclure que les API dont le type de passerelle correspond à celui du produit, ou les API pour lesquelles l'option « Enforced » est désactivée. Les API pour lesquelles l'option « Enforced » est désactivée ne sont pas gérées sur une API Connect passerelle. Si
vous sélectionnez une API incompatible dont le type de passerelle ne correspond pas au type de passerelle du produit, un
message d'avertissement s'affiche et vous ne pouvez pas sauvegarder vos modifications tant que vous ne désactivez pas la sélection
incompatible. Pour plus d'informations sur les types de passerelle, consultez les API Connect sections « Types de passerelle », « Spécification du type de passerelle pour un produit » et « Spécification du type de passerelle pour une définition d'API ».
- Cliquez sur Sauvegarder lorsque vous avez terminé.
Les API sélectionnées sont répertoriées.
Remarque: pour mettre une API à la disposition des développeurs d'applications, vous devez l'inclure dans un plan.
- Facultatif : ajouter une intégration de facturation au produit. Cliquez
sur Plans et, dans la section Intégration de facturation, sélectionnez
la ressource d'intégration de facturation à appliquer au produit.
Dans la section
Plans, vous pouvez éditer le plan par défaut pour ajouter
des informations de tarification ou créer un nouveau plan avec des informations de tarification. Pour plus d'informations sur l'intégration de la facturation, voir
Monétisation de vos produits.
- Facultatif : ajoutez une ou plusieurs formules au produit, ou modifiez une formule existante. Notez qu'un plan par défaut est automatiquement créé, avec une limite de débit
de 100 appels API par heure.
- Cliquez sur Plans.
- Pour ajouter un nouveau plan, cliquez sur Ajouter. Pour modifier un forfait existant, cliquez sur l'icône des options
à côté du forfait souhaité, puis cliquez sur Modifier.
- Indiquez le titre du plan et, éventuellement, une description. Un nom est entré automatiquement.
Remarque: La valeur de la zone Nom est une chaîne unique qui est utilisée pour identifier le plan dans les commandes de l'interface de ligne de commande du kit d'outils de développement . Le Titre est utilisé pour l'affichage.
- Indiquez si votre plan nécessite une approbation des abonnements. Si vous souhaitez que les abonnements des développeurs nécessitent une approbation,
sélectionnez la case à cocher Approbation ; sinon, vérifiez que la case est décochée.
Remarque :Pour consulter l'historique des tâches d'abonnement, procédez comme suit :
- Dans le volet de navigation de l'interface utilisateur de l'API Manager, cliquez sur « Gérer », puis sélectionnez le catalogue avec lequel vous souhaitez travailler.
- Cliquez sur l'onglet « Tâches ».
- Cliquez sur « Historique des validations » dans le volet de navigation.
- Dans la section Tarification du plan , vous pouvez ajouter des informations de tarification en procédant comme suit:
- Remplacez le bouton à bascule par On pour la tarification du plan. La
section de définition de la Tarification du plan s'affiche.
- Si vous voulez inclure des jours d'essai gratuit dans votre plan, sélectionnez Inclure les jours d'essai
gratuit, puis indiquez le nombre de jours d'essai pendant lesquels un abonné peut utiliser le plan
gratuitement avant que le cycle de facturation commence.
- Sélectionnez la Devise utilisée pour le processus de facturation.
- Indiquez le Tarif par mois auquel facturer un abonné. Si la devise
sélectionnée prend en charge les unités fractionnelles, entrez le prix avec les unités fractionnelles, tels
les centimes.
Pour plus d'informations sur l'intégration de la facturation de produit, voir
Définition d'un produit avec l'intégration de la facturation.
- Dans la section Limites de débit du plan , vous pouvez modifier une limite de débit et cliquer sur Ajouter pour ajouter d'autres limites de débit. Vous pouvez définir plusieurs limites de débit, à des intervalles en secondes, minutes,
heures, jours et semaines. Pour supprimer une limite de débit, cliquez sur l'icône de suppression
correspondante.
- Dans la section Limites de diffusion en rafale du plan , vous pouvez modifier une limite de diffusion en rafale et cliquer sur Ajouter pour ajouter des limites de diffusion en rafale supplémentaires. Vous utilisez des limites de diffusion en rafale pour prévenir les pics d'utilisation qui pourraient
endommager votre infrastructure. Vous pouvez définir plusieurs limites de diffusion en rafale, à des
intervalles en secondes et en minutes. Pour supprimer une limite de rafale, cliquez sur l'icône de suppression correspondante.
Les limites de débit et de diffusion en rafale fonctionnent ensemble pour gérer le
trafic réseau des API couvertes par un plan. Un plan peut avoir plusieurs limites de débit et de diffusion en rafale, mais il est
recommandé de n'affecter qu'un ensemble de limites à chaque période. Ajustez les
limites de débit et de diffusion en rafale pour autoriser le trafic maximal sans
surcharger votre réseau. La limite de débit définit le volume de trafic maximal durable et continu pour l'accès aux API sur votre réseau. La limite de diffusion en rafale définit le volume maximal de trafic à court terme pour votre réseau au cours d'un intervalle (par seconde ou minute).
La limite de diffusion en rafale autorise de courtes rafales de trafic plus important. Lorsque la limite de diffusion en
rafale est dépassée, tout appel API ultérieur sera rejeté jusqu'au début de l'intervalle de limite de diffusion en
rafale suivant. Le compteur de limite de diffusion est remis à zéro au début de l'intervalle suivant, ce qui permet
d'accepter à nouveau les appels API. Ces appels API sont comptabilisés dans le compteur de limite de débit, mais la
réinitialisation du compteur de limite de diffusion est sans incidence sur le compteur de limite de débit.
La limite de débit est le nombre d'appels API autorisés au cours d'une période (par exemple, 1000 appels par seconde). Lorsque
la limite de débit est dépassée et que la limite absolue est activée, tous les appels API ultérieurs sont rejetés. Le compteur de limite de débit est remis à zéro au début de l'intervalle de limite de débit suivant, ce qui permet d'accepter à nouveau les appels API. Si la limite absolue est désactivée, tous les appels API ultérieurs restent acceptés et un message indiquant que la limite de débit est dépassé est consigné. Cela s'appelle une "limite flexible".
La limite absolue n'influe que sur la limite de débit, comme illustré par les scénarios suivants :
- Scénario A
Tableau 1. Limite stricte activée
| Limite absolue |
Limite de diffusion en rafale |
Limite de débit |
| ACTIVE |
100 appels/minute |
1000 appels/jour |
- Si un utilisateur appelle une API 100 fois en une minute, la limite de diffusion en rafale est atteinte. Le 101ème appel
(et tout appel ultérieur) au cours de la même minute sera rejeté. Une fois la minute écoulée, le compteur de limite de
diffusion est réinitialisé. Tous les appels API sont comptabilisés en fonction de la limite de débit de 1000
appels par jour. La réinitialisation du compteur de limite de diffusion est sans incidence sur le compteur de limite de débit.
- Si un utilisateur appelle l'API 99 fois par minute, il n'atteindra pas la limite de diffusion en rafale. Il atteindra
éventuellement la limite de 1000 appels par jour. Le 1001e appel sera rejeté jusqu'à la fin de l'intervalle de limite de
débit d'un jour. Pendant la période de rejet des appels API en raison du dépassement journalier de la limite de débit, la limite de diffusion en rafale ne sera pas activée car les appels sont déjà rejetés.
- Les limites de diffusion en rafale et les limites de débit sont appliquées par consommateur.
- Scénario B
Tableau 2. Limite stricte désactivée
| Limite absolue |
Limite de diffusion en rafale |
Limite de débit |
| DÉSACTIVÉ |
100 appels/minute |
1000 appels/jour |
- Comme dans le scénario A, si un utilisateur appelle l'API 100 fois en une minute, le 101e appel au cours de la même minute sera rejeté, jusqu'à ce que cette minute soit écoulée et que le compteur se réinitialise. Ces appels sont également comptabilisés dans
la limite de débit de 1000 appels par jour.
- Si un utilisateur appelle l'API 99 fois par minute, il n'atteindra pas la limite de diffusion en rafale. Il finira par
atteindre la limite de débit de 1000 appels par jour. Le 1001ème appel sera accepté (puisqu'il n'y a pas de limite
absolue). Un message sera enregistré pour chaque appel ultérieur jusqu'à ce que l'intervalle de temps (un jour) soit écoulé et
que le compteur se réinitialise. Pendant le reste de la journée, la limite de diffusion en rafale restera appliquée et les
appels seront rejetés dès que leur nombre dépassera 100 appels par minute au cours d'une minute donnée.
- Les limites de diffusion en rafale et les limites de débit sont appliquées par consommateur.
Remarque: Lorsque l'option Limite fixe est désélectionnée, la limite de débit est considérée comme une "limite souple". Avec
une limite flexible, les appels ne sont pas rejetés lorsque la limite de débit est atteinte. En revanche, un message est
enregistré dans le fichier journal. Avec une limite flexible, la limite de diffusion en rafale rejette toujours les
appels API après son dépassement.
- Pour inclure dans le plan toutes les API qui ont été incluses dans le produit à l'étape 5, sélectionnez Identique au produit dans la section API de plan .
- Dans la section GraphQL Limites de débit , vous pouvez configurer des limites de débit qui seront appliquées à toutes les API de proxy GraphQL ajoutées au produit.
Les limites de débit suivantes sont disponibles :
- graphql-field-cost
- Applique une limite au coût de zone total calculé pour les appels de requête GraphQL effectués vers les API de proxy GraphQL dans ce plan.
- graphql-design-request
- Applique une limite au nombre total d'appels, dans un des types suivants, effectués vers les API de proxy GraphQL dans ce plan :
- graphql-input-type-cost
- Applique une limite au coût total calculé pour le type d'entrée des appels de requête GraphQL effectués vers les API de proxy GraphQL dans ce plan.
- graphql-type-cost
- Applique une limite au coût total calculé pour le type des appels de requête GraphQL effectués vers les API de proxy GraphQL dans ce plan.
Les coûts calculés dépendent des facteurs de pondération appliqués aux types et aux zones du schéma GraphQL. Pour plus d'informations sur l'API proxy GraphQL et sur la configuration des pondérations de type et de champ, consultez les sections Création d'une API proxy GraphQL et Utilisation de l'éditeur de schéma GraphQL.
- Pour définir une ou plusieurs limites de diffusion en rafale d'assemblage ou limites de nombre d'assemblage, cliquez sur Ajouter dans la section Limites de diffusion en rafale d'assemblage ou Limites de nombre d'assemblage , selon le cas. Pour une limite de diffusion en rafale, indiquez le nombre maximal d'appels autorisés dans un intervalle et pour une limite de nombre, indiquez une limite maximale d'appels. Le nom que vous indiquez est utilisé dans une stratégie de limitation de débit au sein d'un ensemble d'API, ce qui permet à cette stratégie de définir la limite de débit en rafale ou le nombre maximal à appliquer; pour plus d'informations, consultez la section Limitation de débit.
- Pour sélectionner les API à inclure dans le plan, sélectionnez Personnaliser la liste des API de plan dans la section API de plan , puis cliquez sur Editer. La fenêtre Editer les API de plan s'ouvre. Les API disponibles pour la sélection sont celles qui ont été incluses dans le produit à l'étape 5. Utilisez les cases à cocher pour sélectionner les API de votre choix, puis cliquez sur Sauvegarder lorsque vous avez terminé.
- Pour sélectionner les opérations API spécifiques à inclure dans le plan, cliquez sur l'icône des options à côté de l'API souhaitée, puis cliquez sur « Modifier la liste des opérations ». La fenêtre Sélectionner les opérations à inclure s'ouvre. Utilisez les cases à cocher pour sélectionner les opérations de votre choix, puis cliquez sur Sauvegarder lorsque vous avez terminé.
- Pour supprimer une API du forfait, cliquez sur l'icône des options à côté de l'API souhaitée dans la section « API du forfait », puis cliquez sur « Supprimer ».
- Pour toutes les API GraphQL du plan, si
vous voulez empêcher les abonnés à ce plan d'utiliser certains types ou zones, procédez
comme suit :
- Cliquez sur l'icône des options à côté de l'API « GraphQL » souhaitée dans la section « API du forfait », puis cliquez sur « Modifier les paramètres d'affichage ».
- Pour empêcher l'utilisation d'un type GraphQL, désélectionnez la case à cocher en regard de ce type.
- Pour empêcher l'utilisation d'une zone dans un type, développez le type, puis désélectionnez la case à cocher
en regard de cette zone.
- Lorsque vous avez terminé, cliquez sur Suivant. Une fenêtre récapitulative s'ouvre. Si l'opération est
autorisée, tous les éléments connexes qui seront également masqués sont répertoriés ; par exemple, si vous masquez un
type et que ce type est référencé en tant que type de données d'une zone sur un autre type, cette zone est également
masquée. Si l'opération n'est pas autorisée, une explication s'affiche.
- Si l'opération est autorisée, cliquez sur Terminé pour appliquer vos modifications. Si
l'opération n'est pas autorisée, cliquez sur Annuler pour fermer la fenêtre ou cliquez
sur Précédent et modifiez vos paramètres.
Vous pouvez utiliser l'option Edition des paramètres afficher/masquer pour modifier les paramètres
existants ; vous pouvez masquer des types ou des zones supplémentaires et afficher des types ou des zones
précédemment masqués.
- Pour définir des limites de débit pour des opérations API spécifiques, sélectionnez « Remplacer les limites de débit du forfait pour une opération individuelle » dans la section « API du forfait »; pour plus d'informations, consultez la section « Définition des limites de débit pour une opération API ».
- Cliquez sur Sauvegarder pour sauvegarder vos modifications.
- Facultatif : Indiquez les métadonnées du plan à afficher avec le plan dans le catalogue des consommateurs :
- Cliquez sur l'onglet Source pour afficher la source OpenAPI du plan.
- Ajoutez l'attribut personnalisé
x-name:
value dans la section plan appropriée. Par exemple : ...
plans:
default-plan:
title: Default Plan
description: Default Plan
x-customarg: This is the custom value
rate-limits:
default:
value: 100/1hour
hard-limit: false
minute:
value: 20/1minute
hard-limit: false
apis:
petstore-header-clientid1.0.0: {}
...
Où
customarg est le nom des métadonnées personnalisées et
This is the custom value est le contenu des informations.
- Cliquez sur Sauvegarder.
Lorsque le plan est publié dans le
catalogue des consommateurs, les métadonnées personnalisées s'affichent avec le plan. Par exemple :
- Facultatif : cliquez sur « Catégories », puis définissez les catégories dans lesquelles vous souhaitez classer votre produit. Cliquez sur « Enregistrer » pour enregistrer les modifications.
En classant vos produits par catégories, vous pouvez présenter vos produits sous forme hiérarchique dans le
catalogue grand public. Pour plus d'informations, consultez le site
tapic_apionprem_categories.html.
Etape suivante
Mettez un produit en préproduction dans un catalogue. Pour plus d'informations, consultez la section « Mise en place d'une version préliminaire d'un produit ».