Vous consultez la documentation Apigee Edge.
Accédez à la
documentation**Apigee X**. info
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.
- Achetez la monétisation. Edge n'inclut pas initialement l'API de monétisation ni l'intégration de 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 de l'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 :
- Collaborez avec l'équipe de configuration Apigee pour effectuer la configuration initiale de la monétisation. Consultez Configuration initiale avec Apigee.
- Configurez la monétisation. Consultez Configurer la monétisation.
- Monétisez vos API. Consultez Monétiser vos API.
- Gérez la monétisation en créant des rapports, en gérant les soldes des comptes, etc. Consultez Gérer la monétisation.
Configuration initiale avec Apigee
Collaborez avec l'équipe de configuration Apigee Edge pour effectuer la configuration initiale de la monétisation. En fonction de vos entrées, l'équipe de configuration configurera les éléments suivants :
- Indiquez si votre organisation est une entreprise de télécommunications.
- Indiquez le type de facturation que vous souhaitez prendre en charge pour les développeurs qui achètent vos plans tarifaires : prépaiement, post-paiement ou les deux. Consultez Comptes prépayés et post-payés.
- Indiquez si vous souhaitez que des données détaillées ou récapitulatives soient extraites de la monétisation dans votre système de comptabilité, ainsi que le format de données requis.
- Indiquez une adresse de réponse personnalisée. Pour les notifications par e-mail de monétisation envoyées aux entreprises et aux développeurs, une adresse par défaut noreply@apigee.com 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, ainsi qu'avec les développeurs, les applications et les produits d'API que vous avez créés à l'aide d'Apigee Edge. L'assistance Apigee peut vous demander de synchroniser votre organisation à l'avenir, comme décrit dans Synchroniser les données Apigee Edge avec la monétisation pour en savoir plus. Ne synchronisez pas les données de monétisation, sauf si Apigee vous y invite.
Configurer la monétisation
Le tableau suivant récapitule les étapes nécessaires pour configurer la monétisation pour votre organisation Apigee.| Étape | 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 modifier 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 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 les devises utilisées par un développeur ou un plan tarifaire). Remarque : La monétisation exécute automatiquement une tâche quotidienne qui obtient 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 à 00h00 et 1 seconde. Pour en savoir plus, consultez Planifier des tâches de monétisation. |
| Spécifier les conditions d'utilisation | Vous pouvez également ajouter des conditions d'utilisation au profil de votre organisation avant de publier des plans tarifaires. Une fois que vous avez publié un plan tarifaire, la version actuelle des conditions d'utilisation s'affiche dans le portail des développeurs. Remarque : Les conditions d'utilisation se trouvent en dehors du profil de votre organisation. Dans le profil de votre organisation, vous spécifiez l'emplacement (URL publique) des conditions d'utilisation. Vous pouvez ajouter plusieurs versions des conditions d'utilisation pour refléter les modifications au fil du temps. |
| Appliquer des limites de monétisation | Associez la règle MonetizationLimitsCheck aux proxys d'API pour appliquer des limites de monétisation. Plus précisément, la règle est déclenchée dans les conditions suivantes :
|
| Configurer les notifications | Configurez les notifications pour informer les développeurs ou les fournisseurs d'API d'un événement spécifique, tel qu'un plan tarifaire récemment publié. |
Monétiser vos API
Lorsque vous monétisez des API, vous regroupez un ou plusieurs produits d'API dans un groupe de produits d'API et définissez le plan tarifaire associé.
Un groupe de produits d'API n'est visible par les développeurs que lorsque vous publiez un plan tarifaire pour le package (avec une date de début correspondant à la date actuelle ou à une date ultérieure). Les développeurs ne peuvent enregistrer leurs applications pour utiliser un groupe de produits d'API qu'en achetant l'un des plans tarifaires actuellement en vigueur. Si un groupe de produits d'API ne dispose pas d'un plan tarifaire publié et actuellement en vigueur, le package n'est pas monétisé.
Le tableau suivant récapitule les étapes nécessaires pour monétiser vos API.
| Étape | Description |
|---|---|
| Gérer les groupes de produits d'API | Créez des groupes de produits d'API pour regrouper vos produits d'API. Remarque : Dans l'interface utilisateur Classic Edge et l'API de monétisation, les groupes de produits sont appelés packages d'API. Pour utiliser l'API afin de gérer les groupes de produits d'API, consultez les sections 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 pour un produit d'API, y compris les attributs personnalisés. Pour utiliser l'API afin de configurer la règle d'enregistrement des transactions, consultez les sections 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, indiquez si vous facturez un tarif fixe ou variable pour l'utilisation de votre API. Pour gérer les plans tarifaires à l'aide de l'API, consultez les sections suivantes : |
| Acheter un plan tarifaire publié | Achetez un plan tarifaire publié, et faites-le expirer ou annulez-le si vous le souhaitez, à l'aide de l'API. |
| Configurer la monétisation dans le portail des développeurs | Configurez la monétisation sur votre portail des développeurs afin de permettre aux développeurs d'accéder en libre-service aux abonnements aux plans tarifaires, aux traitements des paiements et facturations automatiques, aux rapports, aux catalogues de produits et à d'autres paramètres spécifiques à la monétisation. |
Gérer la 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écapitulées dans le tableau suivant :
| Étape | Description |
|---|---|
| Gérer les entreprises et les développeurs | Gérez les entreprises et les développeurs qui utilisent vos API. Un développeur est une entité unique, identifiée de manière unique par son 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 sur le solde prépayé, les revenus et les écarts. Pour les développeurs prépayés, vous pouvez rapprocher les rapports sur le solde prépayé des dépôts bancaires. |
| Effectuer des ajustements de facturation | Effectuez des ajustements de facturation pour corriger les écarts dans vos enregistrements, par exemple. |
| Émettre des crédits | Émettez des crédits pour les développeurs, si nécessaire. Pour un développeur prépayé, un crédit apparaît comme une réduction de l'utilisation qui augmente le solde prépayé du développeur à l'avenir. Pour un développeur post-payé, un crédit apparaît sur une ligne distincte d'une facture, ce qui réduit les frais sur une facture. |
| Gérer le solde des comptes prépayés | Affichez le solde actuel du compte prépayé et rechargez les comptes prépayés ou configurez le rechargement automatique à l'aide d'un fournisseur de services de paiement tiers. |
| Gérer les soldes post-payé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. De plus, vous pouvez définir la limite de crédit pour un développeur post-payé individuel. Dans ce cas, la limite de crédit remplace toute limite définie pour la devise uniquement pour le développeur spécifié. |
| Publier des remboursements | Publiez des remboursements pour les développeurs pour les transactions d'achat. |
| Planifier des tâches de monétisation | La monétisation fournit un planificateur de tâches et un ensemble de tâches prévues pour s'exécuter à des moments désignés. Gérez la planification des tâches de monétisation à l'aide de l'API. |
| Afficher l'état des transactions | Affichez l'état des transactions qui se sont produites au cours d'une période spécifiée à l'aide de l'API. |
| Synchroniser les données Apigee Edge avec la monétisation | Si Apigee vous y invite, resynchronisez les données avec la monétisation pour vous assurer qu'elles sont synchronisées. Vous pouvez synchroniser les éléments suivants : organisation, produits d'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 de test ou supprimer une organisation. |