Gérer les rapports

Vous consultez la documentation Apigee Edge.
Accéder à la documentation sur Apigee X en savoir plus

Introduction

Les rapports de monétisation vous permettent d'accéder à des informations ciblées sur l'utilisation et les transactions. Par exemple, vous pouvez déterminer les applications, les développeurs, les groupes de produits d'API ou les produits d'API ayant enregistré une activité de transaction pour une plage de dates donnée. Avec la monétisation, vous pouvez générer des rapports récapitulatifs ou détaillés qui suivent l'utilisation de l'API.

Types de rapports de monétisation

Vous pouvez générer les types de rapports de monétisation suivants.

À propos de la conservation des données

Dans le cloud public Apigee Edge, la conservation des données de monétisation est un droit d'accès lié à un forfait. Pour connaître les droits d'accès à la monétisation, consultez la page https://cloud.google.com/apigee/specsheets. Contactez le service commercial d'Apigee si vous souhaitez que les données de monétisation soient conservées au-delà de la période des droits d'accès. La conservation étendue des données est activée au moment de la demande et ne peut pas être activée rétroactivement pour inclure les données antérieures à la période de conservation initiale.

À propos des transactions en double

Si vous comparez les rapports sur les transactions de monétisation aux données Analytics, vous remarquerez peut-être un petit nombre de transactions en double. Ce comportement est normal, car le système de monétisation peut traiter plusieurs millions de transactions par jour, et de nombreuses transactions sont traitées en parallèle à tout moment. En moyenne, environ 0,1% des transactions peuvent être des doublons.

Explorer la page "Rapports de monétisation"

Accédez à la page des rapports de monétisation, comme décrit ci-dessous.

Configurer un rapport

Configurez un rapport à l'aide de l'interface utilisateur, comme décrit dans les sections suivantes.

Procédure de configuration d'un rapport

Configurez un rapport à l'aide de l'interface utilisateur Edge ou Classice Edge.

Configurer un rapport sur la facturation

Suivez la procédure de configuration d'un rapport et saisissez les informations suivantes sur la page du rapport:

Configurer un rapport sur la réserve prépayée

Configuration d'un rapport sur les revenus

Suivez la procédure de configuration d'un rapport et saisissez les informations suivantes sur la page du rapport:

Inclure des attributs de transaction personnalisés dans les rapports récapitulatifs sur les revenus

Les règles d'enregistrement des transactions vous permettent de capturer des données sur les attributs personnalisés à partir des transactions. Vous pouvez les inclure dans les rapports récapitulatifs sur les revenus. Définissez l'ensemble d'attributs personnalisés par défaut inclus dans les tables de la base de données de monétisation en définissant la propriété MINT.SUMMARY_CUSTOM_ATTRIBUTES pour votre organisation.

L'utilisation de cette fonctionnalité nécessite une certaine réflexion et une certaine planification. Nous vous invitons donc à passer en revue les points suivants.

Si vous êtes un client cloud, contactez l'assistance Apigee Edge pour définir la propriété. Si vous êtes un client Apigee Edge for Private Cloud, définissez l'indicateur à l'aide d'une requête PUT vers l'API suivante avec des identifiants d'administrateur système.

curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \
"<Organization type="trial" name="MyOrganization">
    <Properties>
        <Property name="features.isMonetizationEnabled">true</Property>
        <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

Dans cet exemple, l'appel d'API active la fonctionnalité et ajoute les colonnes partner_id et tax_source à la base de données de monétisation. Notez que le tableau d'attributs personnalisés dans l'appel d'API est encodé au format URL.

Remarques concernant l'inclusion d'attributs de transaction personnalisés dans les rapports

• Veillez à bien identifier les noms d'attributs que vous souhaitez utiliser avant de les créer avec l'API. Il s'agit de noms de colonnes dans la base de données, dans laquelle les données d'attributs personnalisés y sont toujours stockées.
• Chaque règle d'enregistrement des transactions offre 10 emplacements d'attributs personnalisés, comme illustré ci-dessous. Utilisez exactement les mêmes noms et positions d'attributs pour les mêmes attributs dans les produits qui seront inclus dans les rapports. Par exemple, dans la règle d'enregistrement des transactions suivante, les attributs personnalisés partner_id et tax_source occupent respectivement les cases 4 et 5. Il doit s'agir de son nom et de sa position dans toutes les règles d'enregistrement des transactions pour les produits à inclure dans les rapports.
  
  

Pour inclure des attributs personnalisés dans un rapport récapitulatif sur les revenus après avoir activé la fonctionnalité, utilisez l'API du rapport en ajoutant transactionCustomAttributes à MintCriteria. Consultez la section Options de configuration des critères.

Configurer un rapport de variance (obsolète)

Suivez la procédure de configuration d'un rapport et saisissez les informations suivantes sur la page du rapport:

Générer et télécharger un rapport

Une fois le rapport créé, vous pouvez télécharger les résultats au format CSV ou ZIP. Vous pouvez générer le fichier CSV ou ZIP de manière synchrone ou asynchrone.

• Pour un rapport synchrone, vous exécutez la demande de rapport et celle-ci est bloquée jusqu'à ce que le serveur de données analytiques fournisse une réponse. Toutefois, étant donné qu'un rapport peut nécessiter le traitement d'une grande quantité de données (par exemple, des centaines de Go), il est possible qu'un rapport synchrone échoue en raison de l'expiration d'un délai.

  Un niveau de rapport récapitulatif n'accepte que la génération synchrone.

• Pour un rapport asynchrone, vous exécutez la demande de rapport et récupérez les résultats ultérieurement. Le traitement asynchrone des demandes peut constituer une bonne alternative dans certains cas, par exemple :

  • Analyse et création de rapports couvrant de grands intervalles de temps
  • Analyse des données avec diverses dimensions de regroupement et d'autres contraintes qui ajoutent de la complexité à la requête
  • Gestion des requêtes lorsque vous constatez que les volumes de données ont considérablement augmenté pour certains utilisateurs ou organisations

  Le niveau de rapport Détaillé est compatible avec la génération asynchrone.

Pour générer et télécharger un rapport au format CSV ou ZIP, effectuez l'une des tâches suivantes:

1. Accédez à la page "Rapports".
2. Placez le curseur sur le rapport que vous souhaitez télécharger.

3. Dans la colonne Modifié, cliquez sur l'une des options suivantes:

   1. Icône ou (pour un rapport récapitulatif) Le rapport est enregistré au format CSV ou ZIP de manière synchrone.
   2. Submit job (Envoyer le job) (pour obtenir un rapport détaillé) La tâche asynchrone démarre.

      1. Surveillez l'état de la tâche dans la colonne Modified (Modification).

         L'icône en forme de disque s'affiche lorsque le rapport est prêt à être téléchargé:

         
      2. Une fois la tâche terminée, cliquez sur l'icône du disque pour télécharger le rapport.

Vous trouverez ci-dessous un exemple de fichier CSV pour un rapport récapitulatif sur la facturation.

Modifier un rapport

Pour modifier un rapport :

1. Accédez à la page "Rapports".
2. Placez le curseur sur le rapport que vous souhaitez modifier, puis cliquez sur dans le menu d'actions.
3. Mettez à jour la configuration du rapport, si nécessaire.
4. Cliquez sur Mettre à jour le rapport pour enregistrer la nouvelle configuration du rapport.

Supprimer un rapport

Pour supprimer un rapport:

1. Accédez à la page "Rapports".
2. Placez le curseur sur le rapport que vous souhaitez supprimer.
3. Cliquez sur dans le menu d'actions.

Gérer les rapports de monétisation à l'aide de l'API

Les sections suivantes expliquent comment gérer les rapports de monétisation à l'aide de l'API.

Configurer un rapport à l'aide de l'API

Pour configurer un rapport pour l'ensemble d'une organisation, envoyez une requête POST à /organizations/{org_name}/report-definitions.

Pour configurer un rapport pour un développeur spécifique, envoyez une requête POST à /organizations/{org_name}/developers/{dev_id}/report-definitions, où {dev_id} correspond à l'identification du développeur.

Lorsque vous envoyez la demande, vous devez spécifier le nom et le type du rapport. Le type est l'un des suivants: BILLING, REVENUE, VARIANCE (obsolète) ou PREPAID_BALANCE. En outre, vous pouvez spécifier des critères dans la propriété mintCriteria pour configurer davantage le rapport. Vous pouvez spécifier un large éventail de critères. Vous bénéficiez ainsi d'une grande flexibilité pour configurer le rapport. Vous pouvez spécifier les critères suivants:

• Pour un rapport sur la facturation ou la réserve prépayée, le mois de facturation du rapport
• Pour un rapport sur les revenus, type de transactions couvertes dans le rapport (par exemple, transactions d'achat, transactions de facturation et remboursements)
• Pour un rapport sur la réserve prépayée, le développeur auquel s'applique le rapport
• Pour un rapport sur les revenus, les groupes de produits (ou packages d'API), les produits, les plans tarifaires et les applications auxquels le rapport s'applique
• Pour un rapport sur les revenus ou les variations, la devise applicable au rapport
• Pour les rapports sur la facturation, le solde prépayé ou les revenus, qu'il s'agisse d'un rapport récapitulatif ou détaillé
• Pour un rapport récapitulatif sur les revenus, incluez des attributs de transaction personnalisés dans le rapport.

Consultez Options de configuration des rapports pour obtenir la liste complète des critères du rapport.

L'exemple suivant crée un rapport sur les revenus qui résume l'activité des transactions du mois de juillet 2015. Le rapport comprend divers types de transactions spécifiés dans la propriété transactionTypes, et s'applique spécifiquement au groupe de produits de l'API Payment et au produit de l'API Payment. Étant donné qu'aucun développeur ou application spécifique n'est spécifié dans la définition du rapport, celui-ci s'applique à l'ensemble des développeurs et des applications. De plus, comme la propriété currencyOption est définie sur LOCAL, chaque ligne du rapport s'affichera dans la devise du plan tarifaire applicable. De plus, la propriété groupBy indique que les colonnes du rapport sont regroupées dans l'ordre suivant: PACKAGE, PRODUIT, DÉVELOPPEUR, APPLICATION et PLANIFICATION (y compris le nom et l'ID du plan tarifaire dans le rapport).

$ curl -H "Content-Type: application/json" -X POST -d \
'{
      "name": "July 2015 revenue report",
      "description": " July 2015 revenue report for Payment product",
      "type": "REVENUE",     
      "mintCriteria":{
         "fromDate":"2015-07-01 00:00:00",
         "toDate":"2015-08-01 13:35:00",
         "showTxDetail":true,
         "showSummary":true,
         "transactionTypes":[
            "PURCHASE",
            "CHARGE",
            "REFUND",
            "CREDIT",
            "SETUPFEES",
            "TERMINATIONFEES",
            "RECURRINGFEES"
         ],
         "monetizationPackageIds":[
            "payment"
         ],
         "productIds":[
            "payment"
         ],
         "currencyOption":"LOCAL",
         "groupBy":[
            "PACKAGE",
            "PRODUCT",
            "DEVELOPER",
            "APPLICATION",
            "RATEPLAN"
         ]
      }
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \
-u email:password

L'exemple suivant crée un rapport de facturation détaillé qui montre l'activité d'un développeur DEV CINQ pour le mois de juin 2015.

$ curl -H "Content-Type:application/json" -X POST -d \
'{
      "name": "June billing report, DEV FIVE",
      "description": "June billing report, DEV FIVE",
      "type": "BILLING",      
      "mintCriteria":{
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":true,
         "showSummary":false,         
         "currencyOption":"LOCAL"         
      },
      "devCriteria":[{
         "id":"RtHAeZ6LtkSbEH56",
         "orgId":"myorg"}]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \
-u email:password

Afficher les configurations de rapport à l'aide de l'API

Vous pouvez afficher une configuration de rapport spécifique ou toutes les configurations de rapport d'une organisation. Vous pouvez également afficher les configurations de rapports pour un développeur spécifique.

Pour afficher une configuration de rapport spécifique pour une organisation, envoyez une requête GET à /organizations/{org_name}/report-definitions/{report_definition_id}, où {report_definition_id} correspond à l'identification de la configuration de rapport spécifique (l'ID est renvoyé dans la réponse lorsque vous créez la configuration de rapport). Exemple :

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \
-u email:password

Pour afficher toutes les configurations de rapport pour l'organisation, envoyez une demande GET à /organizations/{org_name}/report-definitions.

Vous pouvez transmettre les paramètres de requête suivants pour filtrer et trier les résultats:

Par exemple, le code suivant renvoie les configurations de rapport pour l'organisation et limite la récupération à un maximum de cinq configurations de rapport:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ 
-u email:password

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
  "reportDefinition" : [ {
    "description" : "Test revenue report",
    "developer" : null,
    "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5",
    "lastModified" : "2015-08-27 15:44:03",
    "mintCriteria" : {
      "asXorg" : false,
      "currencyOption" : "LOCAL",
      "fromDate" : "2015-07-01 00:00:00",
      "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ],
      "monetizationPackageIds" : [ "payment" ],
      "productIds" : [ "payment" ],
      "showRevSharePct" : false,
      "showSummary" : true,
      "showTxDetail" : true,
      "showTxType" : false,
      "toDate" : "2015-08-01 00:05:00",
      "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ]
    },
    "name" : "Test revenue report",
    "organization" : {
      ...
    },
    "type" : "REVENUE"
  }, {
    "description" : "June billing report, DEV FIVE",
    "developer" : null,
    "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
    "lastModified" : "2015-08-27 17:13:20",
    "mintCriteria" : {
      "asXorg" : false,
      "billingMonth" : "JUNE",
      "billingYear" : 2015,
      "currencyOption" : "LOCAL",
      "showRevSharePct" : false,
      "showSummary" : false,
      "showTxDetail" : true,
      "showTxType" : false
    },
    "name" : "June billing report, DEV FIVE",
    "organization" : {
      ...
    },
    "type" : "BILLING"
  } ],
  "totalRecords" : 2
}

Pour afficher les configurations de rapport d'un développeur spécifique, envoyez une requête GET à /organizations/{org_name}/developers/{dev_id}/report-definitions, où {dev_id} correspond à l'identification du développeur. Lorsque vous effectuez la requête, vous pouvez spécifier les paramètres de requête décrits ci-dessus pour filtrer et trier les données.

Par exemple, la requête suivante renvoie les configurations de rapport pour un développeur spécifique et trie la réponse par nom de rapport:

$ curl -H "Accept:application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ 
-u email:password

Mettre à jour une configuration de rapport à l'aide de l'API

Pour mettre à jour la configuration d'un rapport, envoyez une requête PUT à /organizations/{org_name}/report-definitions/{report_definition_id}, où {report_definition_id} correspond à l'identification de la configuration de rapport spécifique. Lors de la mise à jour, vous devez spécifier dans le corps de la requête les valeurs de configuration mises à jour et l'ID de la configuration du rapport. Par exemple, la requête suivante convertit le rapport en rapport récapitulatif (les propriétés mises à jour sont mises en surbrillance):

$ curl -H "Content-Type: application/json" -X PUT -d \
 '{
       "id": "fedac696-ce57-469b-b62c-a77b535fd0eb",
       "name": "June billing report, DEV FIVE",
       "description": "June billing report, DEV FIVE",
       "type": "BILLING",      
       "mintCriteria":{      
         "billingMonth": "JUNE",
         "billingYear": 2015,
         "showTxDetail":false,
         "showSummary":true    
        }     
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
 "description" : "June billing report, DEV FIVE",
  "developer" : null,
  "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb",
  "lastModified" : "2015-08-27 17:47:29",
  "mintCriteria" : {
    "asXorg" : false,
    "billingMonth" : "JUNE",
    "billingYear" : 2015,
    "showRevSharePct" : false,
    "showSummary" : true,
    "showTxDetail" : false,
    "showTxType" : false
  },
  "name" : "June billing report, DEV FIVE",
  "organization" : {
    ... 
  },
  "type" : "BILLING"
}

Supprimer une configuration de rapport à l'aide de l'API

Pour supprimer une configuration de rapport, envoyez une requête DELETE à /organizations/{org_namer}/report-definitions/{report_definition_id}, où {report_definition_id} correspond à l'identification de la configuration de rapport à supprimer. Exemple :

$ curl -H "Accept:application/json" -X DELETE \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \
-u email:password

Générer un rapport à l'aide de l'API

Après avoir configuré un rapport, vous pouvez le générer au format de fichier CSV (valeurs séparées par une virgule) pour l'afficher.

Pour générer un rapport, envoyez une requête POST à organizations/{org_id}/{report_type}, où {report_type} spécifie le type de rapport que vous souhaitez générer. Les types sont les suivants:

• billing-reports
• revenue-reports
• prepaid-balance-reports
• variance-reports

Par exemple, pour générer un rapport sur la facturation, envoyez une requête POST à organizations/{org_name}/billing-reports.

Dans le corps de la demande (pour tout type de rapport), spécifiez les critères de recherche du rapport. Utilisez les propriétés mintCriteria pour spécifier les critères de recherche. Pour en savoir plus, consultez Options de configuration des critères.

Par exemple, la requête suivante recherche un rapport sur les revenus en fonction de différents critères, tels que les dates de début et de fin du rapport et les types de transactions.

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

S'il le trouve, le rapport sur les revenus est généré au format de fichier CSV. Voici un exemple de résultat du rapport:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,

Inclure des attributs personnalisés de développeur dans des rapports sur les revenus à l'aide de l'API

Pour les rapports sur les revenus uniquement, vous pouvez inclure des attributs personnalisés dans le rapport, s'ils sont définis pour le développeur. Vous définissez des attributs personnalisés lorsque vous ajoutez des développeurs à votre organisation, comme décrit dans la section Gérer les développeurs d'applications.

Pour inclure des attributs personnalisés dans un rapport sur les revenus, envoyez une requête POST à organizations/{org_name}/revenue-reports et incluez le tableau devCustomAttributes dans le corps de la requête:

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]

Remarque:Ne spécifiez pas les attributs prédéfinis MINT_* et ADMIN_* dans le tableau devCustomAttributes.

Par exemple, l'exemple suivant inclut trois attributs personnalisés, BILLING_TYPE, SFID et ORG_EXT, dans le rapport (s'ils sont définis pour le développeur):

$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \
'{
      "fromDate":"2015-07-01 00:00:00",
      "toDate":"2015-08-01 13:35:00",
      "showTxDetail":true,
      "showSummary":true,                
      "transactionTypes":[
        "PURCHASE",
        "CHARGE",
        "REFUND",
        "CREDIT",
        "SETUPFEES",
        "TERMINATIONFEES",
        "RECURRINGFEES"
      ],
      "currencyOption":"LOCAL",
      "groupBy":[
        "PACKAGE",
        "PRODUCT",
        "DEVELOPER",
        "APPLICATION",
        "RATEPLAN"
      ],
      "devCustomAttributes": [
         "BILLING_TYPE",
         "SFID",
         "ORG_EXT"
      ]
 }' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \
-u email:password

Vous trouverez ci-dessous un exemple de sortie du rapport qui inclut les valeurs des deux attributs personnalisés:

Reporting Period:,From:,2015-07-01,  To:,2015-07-31
API Product:,All
Developer:,All
Application:,All
Currency:,Local
Type of Report:,Summary Revenue Report

Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT 
Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,

Créer des rapports sur les activités de transaction à l'aide de l'API

Vous pouvez afficher l'activité de transaction d'une organisation en envoyant une requête POST à /organizations/{org_name}/transaction-search. Lorsque vous effectuez la requête, vous devez spécifier des critères de récupération. Vous pouvez spécifier les critères suivants:

• Identifiant d'un ou de plusieurs produits API pour lesquels des transactions ont été émises.
• Mois et année de facturation des transactions.
• Développeur(s) ayant émis la transaction.
• Type de la transaction (achat, frais de configuration, etc.).
• État de la transaction (réussite et échec, par exemple).

Consultez Options de configuration des critères pour obtenir la liste complète des critères.

Par exemple, la requête suivante renvoie les transactions émises par un développeur spécifique pour le mois de facturation de juin 2015:

$ curl -H "Content-Type:application/json" -X POST -d \
 '{        
    "billingMonth": "JUNE",
    "billingYear": 2015,
    "devCriteria": [{
      "id": "RtHAeZ6LtkSbEH56",
      "orgId":"myorg"}],
    "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"],
    "transactionStatus": ["SUCCESS", "FAILED"]
    }'
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \
-u email:password

Vous pouvez également déterminer les applications, les développeurs, les bundles de produits d'API ou les produits d'API qui ont enregistré une activité de transaction au cours d'une période donnée. Vous affichez ces informations séparément pour chaque type d'objet. Par exemple, vous pouvez afficher des informations spécifiques sur les applications qui accèdent aux API dans vos lots de produits d'API monétisés au cours d'une période spécifiée.

Pour afficher des informations sur l'activité des transactions, envoyez une requête GET à l'une des ressources suivantes:

Lorsque vous émettez la requête, vous devez spécifier comme paramètres de requête une date de début et une date de fin pour la plage de dates. Par exemple, la requête suivante renvoie les développeurs ayant effectué des transactions au cours du mois d'août 2015.

$ curl -H "Accept:application/json" -X GET \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \
-u email:password

La réponse doit se présenter comme suit (seule une partie de la réponse est affichée) :

{
  "developer" : [ {
    "address" : [ {
      "address1" : "Dev Five Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev5@myorg.com",
    "hasSelfBilling" : false,
    "id" : "tJZG6broTpGGGeLV",
    "legalName" : "DEV FIVE",
    "name" : "Dev Five",
    "organization" : {
      ...
    },
    "registrationId" : "dev5",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, {
    "address" : [ {
      "address1" : "Dev Seven Address",
      "city" : "Pleasanton",
      "country" : "US",
      "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9",
      "isPrimary" : true,
      "state" : "CA",
      "zip" : "94588"
    } ],
    "approxTaxRate" : 0.0900,
    "billingType" : "POSTPAID",
    "broker" : false,
    "developerRole" : [ ],
    "email" : "dev7@myorg.com",
    "hasSelfBilling" : false,
    "id" : "VI3l8m8IPAvJTvjS",
    "legalName" : "DEV SEVEN",
    "name" : "Dev Seven",
    "organization" : {
      ...
    },
    "registrationId" : "dev7",
    "status" : "ACTIVE",
    "type" : "UNTRUSTED"
  }, ...
  ]
}

Options de configuration des rapports pour l'API

L'API dispose des options de configuration de rapport suivantes:

Options de configuration des critères

Les options de configuration suivantes sont disponibles pour les rapports via la propriété mintCriteria:

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]