Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur 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.
- Monétisation des achats Edge n'inclut pas initialement l'API de monétisation ni n'intègre la monétisation à 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'UI de monétisation dans Edge pour votre organisation Apigee.
Une fois que vous avez souscrit la monétisation, vous devez effectuer les tâches suivantes:
- Travaillez avec l'équipe de configuration d'Apigee pour terminer 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
Travaillez avec l'équipe de configuration d'Apigee Edge pour finaliser la configuration initiale de la monétisation. Sur la base de vos informations, l'équipe de configuration configurera les éléments suivants:
- Si votre organisation est une entreprise de télécommunications
- Type de facturation que vous souhaitez prendre en charge pour les développeurs qui achètent vos forfaits: prépaiement, postpaiement ou les deux. Consultez Comptes prépayés et postpayés.
- Indiquez si vous souhaitez que les données extraites de la monétisation soient détaillées ou résumées dans votre système comptable, ainsi que le format de données requis.
- Adresse de réponse e-mail personnalisée. Pour les notifications par e-mail de monétisation envoyées aux entreprises et aux développeurs, une adresse noreply@apigee.com est configurée par défaut. 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 que 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 la section Synchroniser les données Apigee Edge avec la monétisation. 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 requises 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 d'Apigee Edge configure votre profil d'organisation.
Vous devez modifier le profil de votre organisation pour ajouter ou mettre à jour des informations la concernant, le cas échéant. Par exemple, vous devrez peut-être modifier le type de facturation, les paramètres de devise ou le modèle de taxes. |
| 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 les devises utilisées par un développeur ou un forfait). Remarque: La monétisation exécute automatiquement une tâche quotidienne qui obtient le taux de change en dollars américains pour chaque devise prise en charge. Par défaut, la tâche s'exécute tous les jours à une seconde après minuit. Pour en savoir plus, consultez Planifier des tâches de monétisation. |
| Spécifier les conditions d'utilisation | Vous pouvez ajouter des conditions d'utilisation au profil de votre organisation avant de publier des forfaits. Une fois que vous avez publié un forfait, la version actuelle des conditions d'utilisation s'affiche dans le portail pour les développeurs. Remarque: Les conditions d'utilisation ne figurent pas dans le profil de votre organisation. Dans le profil de votre organisation, vous devez spécifier l'emplacement (URL publique) des conditions d'utilisation. Vous pouvez ajouter plusieurs versions des conditions d'utilisation pour refléter les modifications apportées 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 se déclenche dans les conditions suivantes:
|
| Configurer les notifications | Configurez des notifications pour informer les développeurs ou les fournisseurs d'API d'un événement spécifique, tel qu'un nouveau plan tarifaire. |
Monétiser vos API
Lorsque vous monétisez des API, vous regroupez un ou plusieurs produits d'API dans un lot de produits d'API et définissez le plan tarifaire associé.
Un lot de produits d'API ne devient visible pour les développeurs que lorsque vous publiez un plan tarifaire pour le package (avec une date de début à la date actuelle ou à une date ultérieure). Les développeurs ne peuvent enregistrer leurs applications pour utiliser un lot de produits d'API qu'en souscrivant l'un des forfaits actuellement en vigueur. Si un app bundle de produits d'API n'a pas de 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.
| Étape | Description |
|---|---|
| Gérer les bundles de produits d'API | Créez des lots de produits d'API pour regrouper vos produits d'API. Remarque: Dans l'interface utilisateur Edge classique 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 bundles de produits API, consultez les pages suivantes: |
| Configurer la règle d'enregistrement des transactions | Configurez la stratégie 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 des transactions d'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 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 tarif 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é, puis expirez-le ou résiliez-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 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:
| Étape | Description |
|---|---|
| Gérer les entreprises et les 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 son adresse e-mail. Une entreprise est un ensemble de développeurs gérés en tant qu'entité unique. |
| Créer des rapports | Créez des rapports sur le solde prépayé, les revenus et les écarts. Pour les développeurs disposant d'une réserve prépayée, vous pouvez rapprocher les rapports sur le solde prépayé avec les dépôts bancaires. |
| Effectuer des ajustements de facturation | Vous pouvez par exemple ajuster la facturation pour corriger les écarts dans vos enregistrements. |
| Émettre des crédits | Attribuez des crédits aux développeurs, si nécessaire. Pour un développeur disposant d'une réserve prépayée, un crédit apparaît comme une réduction de l'utilisation, ce qui augmente le solde prépayé du développeur à l'avenir. Pour un développeur postpayé, un crédit apparaît sur une ligne distincte de la facture, ce qui réduit le montant facturé. |
| Gérer le solde des comptes prépayés | Consultez le solde actuel du compte prépayé et rechargez-le, ou configurez un rechargement automatique à l'aide d'un fournisseur de services de paiement tiers. |
| Gérer les 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 postpayé. La limite de crédit s'applique à tous les développeurs postpayés de l'organisation. Vous pouvez également définir la limite de crédit pour un développeur post-paiement spécifique. Dans ce cas, la limite de crédit remplace toute limite définie pour la devise pour le développeur spécifié uniquement. |
| Remboursements | Publier des remboursements aux 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éprogrammées pour s'exécuter à des heures désignées. Gérez le calendrier des tâches de monétisation à l'aide de l'API. |
| Afficher l'état des transactions | Affichez l'état des transactions effectuées 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 demande de le faire, résynchronisez les données avec la monétisation pour vous assurer qu'elles sont à jour. 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 en supprimer une. |