Configurer la monétisation

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Avant de commencer

Avant de commencer à utiliser la monétisation avec votre organisation Apigee, vous devez effectuer les tâches préalables suivantes:

  • Créez un compte Apigee Edge, comme décrit dans la section Créer un compte Apigee Edge.
  • Souscrivez à la monétisation. Edge n'inclut pas initialement l'API de monétisation et n'intègre pas la monétisation dans l'interface utilisateur de gestion. Vous devez acheter la fonctionnalité de monétisation pour intégrer l'API de monétisation et les composants d'interface utilisateur de monétisation dans Edge pour votre organisation Apigee.

Une fois que vous avez acheté la monétisation, vous devez effectuer les tâches suivantes:

Configuration initiale avec Apigee

Collaborez avec l'équipe de configuration d'Apigee Edge pour terminer la configuration initiale de la monétisation. En fonction de vos informations, l'équipe de configuration définira les éléments suivants:

  • Si votre organisation est une entreprise de télécommunications
  • Le type de facturation que vous souhaitez proposer aux développeurs qui achètent vos forfaits: prépayé, post-payé ou les deux. Consultez la section Comptes prépayés et comptes post-payés.
  • Indique si vous souhaitez des données détaillées ou récapitulatives extraites de la monétisation dans votre système de comptabilité, et le format de données requis.
  • Adresse e-mail personnalisée de réponse Pour les notifications par e-mail de monétisation envoyées aux entreprises et aux développeurs, une adresse noreply@apigee.com par défaut est configurée. Vous devez demander un nom et une adresse de réponse personnalisés pour votre organisation.

L'équipe de configuration Apigee exécute un script pour synchroniser la monétisation avec votre organisation et avec tous les développeurs, applications et produits d'API que vous avez créés avec Apigee Edge. L'assistance Apigee pourra vous demander ultérieurement de synchroniser votre organisation, comme décrit dans la section Synchroniser les données Apigee Edge avec la monétisation pour en savoir plus. Ne synchronisez pas les données de monétisation, sauf indication contraire d'Apigee.

Configurer la monétisation

Le tableau suivant récapitule les étapes requises pour configurer la monétisation pour votre organisation Apigee.
Step Description
Modifier le profil de votre organisation Lors de la configuration initiale de la monétisation, l'équipe de configuration Apigee Edge configure le profil de votre organisation.

Vous devez modifier le profil de l'organisation pour ajouter ou mettre à jour des informations sur votre organisation, le cas échéant. Par exemple, vous devrez peut-être mettre à jour le type de facturation, les paramètres de devise ou le modèle fiscal.

Gérer les devises acceptées Lors de la configuration initiale de la monétisation, l'équipe de configuration d'Apigee Edge spécifie les devises acceptées par votre organisation et définit la devise par défaut.

Vous pouvez récupérer les devises acceptées par votre organisation, et en ajouter ou en supprimer (pour refléter celles utilisées par un développeur ou un plan tarifaire).

Remarque: La monétisation exécute automatiquement une tâche quotidienne qui récupère le taux de change en dollars américains pour chaque devise acceptée. Par défaut, la tâche s'exécute tous les jours à une seconde après minuit. Pour en savoir plus, consultez Planifier des jobs de monétisation.
Spécifier les conditions d'utilisation Si vous le souhaitez, vous pouvez ajouter des conditions d'utilisation au profil de votre organisation avant de publier des plans tarifaires. Une fois le plan tarifaire publié, la version actuelle des conditions d'utilisation s'affiche sur le portail des développeurs.

Remarque: Les conditions d'utilisation ne figurent pas dans le profil de votre organisation. Dans le profil de votre organisation, indiquez l'emplacement (URL publique) des conditions d'utilisation. Vous pouvez ajouter plusieurs versions des conditions d'utilisation afin de refléter les changements au fil du temps.
Appliquer des limites de monétisation Associez la règle MonetizationLimitsCheck aux proxys d'API pour appliquer les limites de monétisation.

Plus précisément, la règle est déclenchée dans les conditions suivantes:

  • Le développeur qui accède à l'API monétisée n'est pas enregistré ou n'est pas abonné au plan tarifaire.
  • Le développeur a dépassé le volume de transactions pour le plan tarifaire abonné.
  • Le solde du compte prépayé du développeur ou la limite de crédit post-payée a été atteint.
Configurer les notifications Configurez des notifications pour informer les développeurs ou les fournisseurs d'API d'un événement spécifique (un nouveau plan tarifaire, par exemple).

Monétiser vos API

Lorsque vous monétisez des API, vous regroupez un ou plusieurs produits d'API dans un lot de produits API et définissez le plan tarifaire associé.

Les développeurs ne peuvent pas voir un lot de produits API tant que vous n'avez pas publié de plan tarifaire pour le package (avec une date de début correspondant à la date du jour ou à une date ultérieure). Les développeurs ne peuvent enregistrer leurs applications pour utiliser un lot de produits API qu'en achetant l'un des plans tarifaires en vigueur. Si un lot de produits API ne dispose pas d'un plan tarifaire publié actuellement en vigueur, le package n'est pas monétisé.

Le tableau suivant récapitule les étapes requises pour monétiser vos API.

Step Description
Gérer les lots de produits API

Créez des lots de produits d'API pour regrouper vos produits d'API.

Remarque: Dans l'interface utilisateur Classic Edge et dans l'API monetization, les groupes de produits sont appelés "packages d'API".

Pour utiliser l'API afin de gérer des lots de produits API, consultez les pages suivantes:
Configurer la règle d'enregistrement des transactions

Configurez la règle d'enregistrement des transactions pour chacun de vos produits d'API. La règle d'enregistrement des transactions définit ce que vous souhaitez capturer dans les enregistrements de transactions d'un produit d'API, y compris tout attribut personnalisé.

Pour configurer la règle d'enregistrement des transactions à l'aide de l'API, consultez les pages suivantes:
Gérer et publier des plans tarifaires

Créez un plan tarifaire pour définir l'approche de monétisation de vos API. Par exemple, si vous facturez un taux fixe ou variable pour l'utilisation de votre API.

Pour gérer les plans tarifaires à l'aide de l'API, consultez les pages suivantes:

Acheter un plan tarifaire publié Achetez un plan tarifaire publié, et annulez ou résiliez un plan tarifaire acheté, si vous le souhaitez, à l'aide de l'API.
Configurer la monétisation sur le portail des développeurs Configurez la monétisation sur votre portail des développeurs afin de leur permettre d'accéder en libre-service à l'abonnement au forfait, au traitement et à la facturation automatiques des paiements, aux rapports, aux catalogues de produits et à d'autres paramètres spécifiques à la monétisation.

Gérer les paramètres de monétisation

Une fois que vous avez configuré la monétisation et monétisé votre API, vous pouvez effectuer une ou plusieurs des étapes résumées dans le tableau suivant:

Step Description
Gérer des entreprises et des développeurs Gérer les entreprises et les développeurs qui utilisent vos API. Un développeur est une entité unique, identifiée de manière unique par l'adresse e-mail. Une entreprise est un ensemble de développeurs gérés comme une seule entité.
Créer des rapports Créez des rapports prépayés sur le solde, les revenus et les écarts. Les développeurs qui ont opté pour le prépaiement peuvent rapprocher des rapports de solde prépayé avec des dépôts bancaires.
Effectuer des ajustements de facturation Effectuez des ajustements de facturation pour corriger les écarts dans vos dossiers, par exemple.
Crédits d'émission Omettre des crédits de développeur, si nécessaire Dans le cas d'un développeur prépayé, un crédit s'affiche comme une réduction de l'utilisation qui augmente le solde prépayé du développeur. Pour un développeur post-payé, un crédit apparaît sur une ligne distincte de la facture, ce qui réduit le montant facturé.
Gérer les soldes prépayés de comptes Consultez le solde prépayé actuel de vos comptes, et rechargez les comptes prépayés ou configurez l'actualisation automatique via un fournisseur de services de paiement tiers.
Gérer vos soldes postpayés à l'aide de limites de crédit Lorsque vous ajoutez une devise acceptée pour une organisation, vous pouvez définir une limite de crédit pour un développeur post-payé. La limite de crédit s'applique à tous les développeurs post-payés de l'organisation. En outre, vous pouvez définir une limite de crédit pour chaque développeur post-payé. Dans ce cas, la limite de crédit remplace toute limite définie pour la devise pour le développeur spécifié.
Publier des remboursements Rembourser les développeurs pour les transactions d'achat
Planifier des missions de monétisation La monétisation fournit un planificateur de tâches et un ensemble de jobs préprogrammés pour s'exécuter à des heures désignées. Gérez le calendrier des jobs de monétisation à l'aide de l'API.
Consulter l'état des transactions Affichez l'état des transactions qui ont eu lieu pendant une période spécifiée à l'aide de l'API.
Synchroniser les données Apigee Edge avec la monétisation Si Apigee vous le demande, resynchronisez les données avec la monétisation pour vous assurer qu'elles sont synchronisées. Vous pouvez synchroniser les éléments suivants: entreprise, produits API, développeurs et applications.
Supprimer les données de monétisation de votre organisation Vous pouvez supprimer les données de monétisation de votre organisation pour effacer une organisation test ou supprimer une organisation.