Configurer des notifications basées sur le total des transactions pour une entreprise et ses développeurs

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

En règle générale, le montant total des transactions est automatiquement suivi pour tous les développeurs d'une entreprise lorsqu'ils utilisent l'application de l'entreprise pour accéder aux API.

Que se passe-t-il si certains de vos développeurs utilisent activement leurs propres applications de développement pour accéder aux API et que vous devez suivre le total de leurs transactions combinées sans aucune interruption du trafic ? Vous pouvez ajouter les développeurs à une entreprise et configurer les notifications à envoyer, basées sur le total des transactions cumulées pour l'entreprise et ses développeurs. Vous devez activer cette fonctionnalité pour chaque entreprise. Elle est désactivée par défaut. Une fois la fonctionnalité activée, le total des transactions combinées est calculé toutes les heures.

Si des notifications sont configurées, elles sont envoyées lorsque les seuils totaux des transactions combinées sont atteints. Une notification distincte est déclenchée pour chaque développeur de l'entreprise qui a accepté le plan de taux de notifications ajustable.

Pour inclure le total des transactions combinées dans les rapports, vous devez inclure manuellement l'entreprise et tous les développeurs concernés dans les critères du rapport. Pour en savoir plus, consultez Créer des rapports.

Pour combiner les transactions totales du plan tarifaire ou celles d'une entreprise et de ses développeurs:

  1. Créez un plan de notification ajustable, comme décrit dans Spécifier les détails du plan de notification ajustable.
  2. Configurez des notifications à l'aide de webhooks, comme décrit dans Configurer des notifications à l'aide de webhooks.
  3. Utilisez l'API Get Company Details (Obtenir des informations sur l'entreprise) pour obtenir tous les attributs existants actuellement définis pour l'entreprise. Vous en aurez besoin à l'étape suivante.
  4. Pour activer cette fonctionnalité, ajoutez l'attribut personnalisé MINT_NOTIFICATION_COMBINE_COMPANY_DEVELOPERS à true de l'entreprise à l'aide de l'API Update Company. Veillez également à inclure les autres attributs de votre entreprise dans l'appel d'API.

    Par exemple, pour activer cette fonctionnalité pour xyz-entreprise:

    $ curl -H "Content-Type:application/json" -X PUT -d \
    '{
        "name": "xyz-company",
        "attributes": [
            {
                "name": "MINT_NOTIFICATION_COMBINE_COMPANY_DEVELOPERS",
                "value": "true"
            }
          ... also include other existing company attributes to avoid losing them
       ]
    }'\
    "https://api.enterprise.apigee.com/v1/organizations/myorg/companies/xyz-company"  \
    -u email:password
    
  5. L'entreprise et ses développeurs acceptent le plan de taux de notifications ajustable.

    Remarque: Afin de réduire les risques de confusion, l'entreprise et les développeurs définissent la même date de début afin que les données de transaction soient suivies sur un intervalle de temps cohérent.

    Please note:

    • Si l'entreprise n'accepte pas le plan tarifaire, la combinaison des totaux des transactions du plan tarifaire pour l'entreprise et ses développeurs n'est pas effectuée.
    • Si un développeur n'accepte pas le plan tarifaire, les appels qu'il effectue vers les produits monétisés seront bloqués.