Estás viendo la documentación de Apigee Edge.
Ir a la documentación de
Apigee X. info
Introducción
Los informes de monetización te permiten acceder a información de uso específica y a la actividad de las transacciones. Por ejemplo, puedes determinar qué aplicaciones, desarrolladores, paquetes de productos de API o productos de API tuvieron actividad de transacciones en un período determinado. Con la monetización, puedes generar informes de resumen o detallados que hagan un seguimiento del uso de la API.
Tipos de informes de monetización
Puedes generar los siguientes tipos de informes de monetización.
| Denunciar | Descripción |
|---|---|
| Facturación | Consulta la actividad de los desarrolladores durante un solo mes de facturación y verifica que los planes de tarifas se hayan aplicado correctamente. |
| Saldo prepagado | Ver las recargas de saldo que realizó un desarrollador prepago en un mes de facturación o en un mes abierto actualmente, para que puedas conciliar los pagos recibidos de tu procesador de pagos |
| Ingresos | Consulta la actividad y los ingresos generados por los desarrolladores en un período, de modo que puedas analizar el rendimiento de tus paquetes y productos de API en todos tus desarrolladores (y sus aplicaciones). |
| Varianza |
Compara la actividad y los ingresos generados por los desarrolladores en dos períodos para que puedas analizar las tendencias ascendentes o descendentes en el rendimiento de tus paquetes y productos de API en todos tus desarrolladores (y sus aplicaciones). |
Acerca de la retención de datos
En la nube pública de Apigee Edge, la retención de datos de monetización es un derecho del plan. Consulta los derechos de monetización en https://cloud.google.com/apigee/specsheets. Comunícate con Ventas de Apigee si deseas que los datos de monetización se conserven más allá del período de derecho. La retención de datos extendida se activa en el momento de la solicitud y no se puede activar de forma retroactiva para incluir datos anteriores al período de retención de datos original.
Acerca de las transacciones duplicadas
Si comparas los informes de transacciones de monetización con los datos de Analytics, es posible que observes una pequeña cantidad de transacciones duplicadas. Este es el comportamiento esperado, ya que el sistema de monetización puede procesar varios millones de transacciones por día, y muchas de ellas se procesan en paralelo en cualquier momento. En promedio, alrededor del 0.1% de las transacciones podrían ser duplicadas.
Explora la página Informes de monetización
Accede a la página Informes de monetización, como se describe a continuación.
Edge
Para acceder a la página Informes con la IU de Edge, haz lo siguiente:
- Accede a apigee.com/edge.
- Selecciona Publicar > Monetización > Informes en la barra de navegación izquierda.
Se mostrará la página Informes.
Como se destaca en la figura, la página Informes te permite hacer lo siguiente:
- Consulta la información de resumen de todos los informes, incluidos el nombre y la descripción, el tipo de informe y el período, y la fecha de última modificación.
- Cómo configurar un informe
- Genera y descarga un informe en formato CSV o de archivo ZIP
- Cómo editar un informe
- Cómo borrar un informe
- Cómo buscar en la lista de informes
Classic Edge (nube privada)
Para acceder a la página Informes con la IU de Classic Edge, haz lo siguiente:
- Accede a
http://ms-ip:9000, donde ms-ip es la dirección IP o el nombre de DNS del nodo del servidor de administración. - Selecciona Monetización > Informes de monetización en la barra de navegación superior.
Se mostrará la página Informes.
- Consulta la lista actual de informes
- Cómo configurar un informe
- Genera y descarga un informe en formato CSV
- Cómo editar un informe
- Cómo borrar un informe
Cómo configurar un informe
Configura un informe con la IU, como se describe en las siguientes secciones.
Pasos para configurar un informe
Configura un informe con la IU de Edge o la IU clásica de Edge.
Edge
Para configurar un informe con la IU de Edge, haz lo siguiente:
- Selecciona Publicar > Monetización > Informes en la barra de navegación izquierda.
- Haz clic en + Informe.
- Configura los detalles del informe definidos en la siguiente tabla.
Campo Descripción Nombre Nombre único del informe. Descripción Descripción del informe. Tipo de informe Consulta Tipos de informes de monetización. - Configura los detalles restantes del informe según el tipo de informe seleccionado, como se describe en las siguientes secciones:
- Después de ingresar la información en la ventana del informe, puedes hacer lo siguiente:
- Haz clic en Guardar informe para guardar la configuración del informe.
Solo para un informe detallado, haz clic en Enviar trabajo para ejecutar el informe de forma asíncrona y recuperar los resultados más adelante. Consulta Cómo generar y descargar un informe para obtener más información.
- Haz clic en Guardar como CSV o Guardar como ZIP para descargar el informe generado en tu máquina local como un archivo de valores separados por comas (CSV) o un archivo zip comprimido que contenga el archivo CSV. Se recomiendan las descargas en ZIP para los informes grandes, ya que se descargarán de manera más eficaz.
Classic Edge (nube privada)
Para crear un informe con la IU de Classic Edge, haz lo siguiente:
- Selecciona Monetización > Informes de monetización en la barra de navegación superior.
- En el menú desplegable, selecciona el tipo de informe que quieres crear. Consulta Tipos de informes de monetización.
- Haz clic en + Denunciar.
- Configura los detalles del informe según el tipo de facturación seleccionado, como se describe en las siguientes secciones:
- Después de ingresar la información en la ventana del informe, puedes hacer lo siguiente:
- Haz clic en Guardar como… para guardar la configuración del informe y descargarlo más tarde.
Solo para un informe detallado, haz clic en Enviar trabajo para ejecutar el informe de forma asíncrona y recuperar los resultados más adelante. Consulta Cómo generar y descargar un informe para obtener más información.
- Haz clic en Descargar CSV para generar y descargar el informe en tu computadora local como un archivo de valores separados por comas (CSV) para visualizarlo.
Cómo configurar un informe de facturación
Sigue los pasos para configurar un informe y, luego, ingresa la siguiente información en la página del informe:
| Campo | Descripción |
|---|---|
| Mes de facturación |
Mes de facturación del informe. |
| Nivel de informes |
Es el nivel de informes. Estos son algunos de los valores válidos:
|
| Paquetes de productos |
Nota: En la IU de Classic Edge, los paquetes de productos de API se denominan paquetes de API. Selecciona los paquetes de productos de API que deseas incluir en el informe. Si no se selecciona ninguno, se incluirán todos los paquetes de productos de API en el informe. El informe incluye una línea separada para cada paquete de productos de API seleccionado. En el caso de un informe de resumen, puedes marcar la opción No mostrar en las opciones de visualización del resumen. En este caso, el informe agrega información de todos los paquetes de productos de la API (o de los seleccionados) y no muestra información de cada paquete de productos de la API por separado. |
| Productos |
Selecciona los productos de API que deseas incluir en el informe. Si no se selecciona ninguno, todos los productos de API se incluyen en el informe. El informe incluye una línea separada para cada producto de API seleccionado. En el caso de un informe de resumen, puedes marcar la opción No mostrar en las opciones de visualización del resumen. En este caso, el informe agrega información de todos los desarrolladores (o de los seleccionados) y no muestra información de cada desarrollador seleccionado por separado. |
| Companies | Selecciona las empresas que se incluirán en el informe. Si no se selecciona ninguna, todas las empresas se incluirán en el informe. |
| Plan de tarifas |
Son los planes de tarifas que se incluirán en el informe. Selecciona una de las siguientes opciones:
|
Cómo configurar un informe de saldo prepago
Sigue los pasos para configurar un informe y, luego, ingresa la siguiente información en la página del informe:| Campo | Descripción |
|---|---|
| Mes de facturación |
Mes de facturación del informe. |
| Nivel de informes |
Es el nivel de informes. Estos son algunos de los valores válidos:
|
| Companies | Selecciona las empresas que se incluirán en el informe. Si no se selecciona ninguna, todas las empresas se incluirán en el informe. |
Cómo configurar un informe de ingresos
Sigue los pasos para configurar un informe y, luego, ingresa la siguiente información en la página del informe:
| Campo | Descripción |
|---|---|
| Período |
Es el período del informe. Selecciona una de las siguientes opciones:
|
| Seleccionar moneda |
Moneda para el informe. Estos son algunos de los valores válidos:
|
| Nivel de informes |
Es el nivel de informes. Estos son algunos de los valores válidos:
|
| Paquetes de productos |
Nota: En la IU de Classic Edge, los paquetes de productos de API se denominan paquetes de API. Selecciona los paquetes de productos de API que deseas incluir en el informe. Si no se selecciona ninguno, se incluirán todos los paquetes de productos de API en el informe. El informe incluye una línea separada para cada paquete de productos de API seleccionado. En el caso de un informe de resumen, puedes marcar la opción No mostrar en las opciones de visualización del resumen. En este caso, el informe agrega información de todos los paquetes de productos de la API (o de los seleccionados) y no muestra información de cada paquete de productos de la API por separado. |
| Productos |
Selecciona los productos de API que deseas incluir en el informe. Si no se selecciona ninguno, todos los productos de API se incluyen en el informe. El informe incluye una línea separada para cada producto de API seleccionado. En el caso de un informe de resumen, puedes marcar la opción No mostrar en las opciones de visualización del resumen. En este caso, el informe agrega información de todos los desarrolladores (o de los seleccionados) y no muestra información de cada desarrollador seleccionado por separado. |
| Companies | Selecciona las empresas que se incluirán en el informe. Si no se selecciona ninguna, todas las empresas se incluirán en el informe. En el caso de un informe de resumen, puedes marcar la opción No mostrar en la sección Opciones de visualización del resumen. En este caso, el informe agrega información de todas las empresas (o de las seleccionadas) y no muestra información de cada empresa seleccionada por separado. |
| Apps |
Selecciona las aplicaciones que deseas incluir en el informe. Si no se selecciona ninguna, se incluirán todas las aplicaciones en el informe. El informe incluye una línea separada para cada aplicación seleccionada. En el caso de un informe de resumen, puedes marcar la opción No mostrar en la sección Opciones de visualización del resumen. En este caso, el informe agrega información de todas las aplicaciones (o de las seleccionadas) y no muestra información de cada aplicación seleccionada por separado. |
| Opciones de visualización del resumen |
Es el orden en que las columnas se agrupan y se muestran en el informe. Selecciona un número que indique el orden relativo de esa sección en la agrupación (1 es la primera agrupación). Por ejemplo, el siguiente informe se agrupa primero por paquetes, luego por productos, después por desarrolladores y, por último, por aplicaciones.
Si no quieres mostrar una sección, selecciona No mostrar y, luego, selecciona los campos restantes en orden. El orden se actualiza automáticamente cuando cambias el orden relativo de una sección o eliges no mostrar una sección en el informe. |
Cómo incluir atributos de transacción personalizados en los informes de resumen de ingresos
Las políticas de grabación de transacciones te permiten captar datos de atributos personalizados de las transacciones, y puedes incluir esos atributos personalizados en los informes de ingresos resumidos. Define el conjunto predeterminado de atributos personalizados incluidos en las tablas de la base de datos de monetización configurando la propiedad MINT.SUMMARY_CUSTOM_ATTRIBUTES para tu organización.
Usar esta función requiere cierta planificación, por lo que debes revisar las consideraciones que se indican a continuación.
Si eres cliente de Cloud, comunícate con el equipo de asistencia de Apigee Edge para configurar la propiedad. Si eres cliente de Apigee Edge para una nube privada, establece la marca con una solicitud PUT a la siguiente API con credenciales de administrador del sistema.
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">["partner_id","tax_source"]</Property> <Property name="features.topLevelDevelopersAreCompanies">false</Property> </Properties> </Organization>"
En este ejemplo, la llamada a la API habilita la función y agrega las columnas partner_id y tax_source a la base de datos de monetización. Ten en cuenta que el array de atributos personalizados en la llamada a la API está codificado como URL.
Consideraciones para incluir atributos de transacción personalizados en los informes
- Asegúrate de los nombres de los atributos que deseas usar antes de crearlos con la API. Esos son los nombres de las columnas en la base de datos, y los datos de los atributos personalizados siempre se almacenan allí.
- Hay 10 espacios disponibles para atributos personalizados en cada política de registro de transacciones, como se muestra en la siguiente imagen. Usa exactamente los mismos nombres y posiciones de atributos para los mismos atributos en todos los productos que se incluirán en los informes. Por ejemplo, en la siguiente política de grabación de transacciones, los atributos personalizados
partner_idytax_sourceocupan las casillas 4 y 5, respectivamente. Debe ser su nombre y cargo en todas las políticas de registro de transacciones para que los productos se incluyan en los informes.
Para incluir atributos personalizados en un informe de ingresos de resumen después de habilitar la función, usa la API de informes agregando transactionCustomAttributes a MintCriteria. Consulta las opciones de configuración de criterios.
Cómo configurar un informe de varianza (obsoleto)
Sigue los pasos para configurar un informe y, luego, ingresa la siguiente información en la página del informe:
| Campo | Descripción |
|---|---|
| Período |
Es el período del informe. Selecciona una de las siguientes opciones:
|
| Paquetes |
Paquetes de la API que se incluirán en el informe. Selecciona una de las siguientes opciones:
El informe incluye una línea separada para cada paquete de API seleccionado. Para un informe de resumen, puedes marcar la opción No mostrar (paquetes) en la sección Opciones de visualización del resumen. En este caso, el informe agrega información de todos los paquetes de API (o de los seleccionados) y no enumera la información de cada paquete de API por separado. |
| Productos |
Productos de API que se incluirán en el informe. Selecciona una de las siguientes opciones:
El informe incluye una línea separada para cada producto de API seleccionado. En el caso de un informe de resumen, puedes marcar la opción No mostrar (productos) en la sección Opciones de visualización del resumen. En este caso, el informe agrega información de todos los productos de API (o de los seleccionados) y no enumera la información de cada producto de API por separado. |
| Companies |
Son las empresas que se incluirán en el informe. Selecciona una de las siguientes opciones:
El informe incluye una línea separada para cada empresa seleccionada. En el caso de un informe de resumen, puedes marcar la opción No mostrar (empresas) en la sección Opciones de visualización del resumen. En este caso, el informe agrega información de todas las empresas (o de las empresas seleccionadas) y no muestra información de cada empresa seleccionada por separado. |
| Apps |
Son las aplicaciones que se incluirán en el informe. Selecciona una de las siguientes opciones:
El informe incluye una línea separada para cada aplicación seleccionada. En el caso de un informe de resumen, puedes marcar la opción No mostrar (aplicaciones) en la sección Opciones de visualización del resumen. En este caso, el informe agrega información de todas las aplicaciones (o de las seleccionadas) y no muestra información de cada aplicación seleccionada por separado. |
| Moneda |
Moneda para el informe. Estos son algunos de los valores válidos:
|
| Opciones de visualización del resumen |
Es el orden en que las columnas se agrupan y se muestran en el informe. Selecciona un número que indique el orden relativo de esa sección en la agrupación (1 es la primera agrupación). Por ejemplo, el siguiente informe se agrupa primero por paquetes, luego por productos, después por desarrolladores y, por último, por aplicaciones.
Si no quieres mostrar una sección, selecciona No mostrar y, luego, selecciona los campos restantes en orden. El orden se actualiza automáticamente cuando cambias el orden relativo de una sección o eliges no mostrar una sección en el informe. |
Cómo generar y descargar un informe
Después de crear un informe, puedes descargar sus resultados en formato CSV o de archivo ZIP. Puedes generar el archivo CSV o ZIP de forma síncrona o asíncrona.
Para un informe síncrono, debes ejecutar la solicitud del informe y la solicitud se bloquea hasta que el servidor de estadísticas proporcione una respuesta. Sin embargo, como un informe podría necesitar procesar una gran cantidad de datos (por ejemplo, 100 de GB), un informe síncrono puede fallar debido a un tiempo de espera.
El nivel de informe Resumen solo admite la generación síncrona.
Para un informe asíncrono, debes ejecutar la solicitud del informe y recuperar los resultados más adelante. Algunos casos en los que el procesamiento de consultas asíncronas puede ser una buena alternativa incluyen los siguientes:
- Análisis y creación de informes que abarquen intervalos grandes
- Análisis de datos con una variedad de dimensiones de agrupación y otras restricciones que agregan complejidad a la consulta.
- Administración de consultas cuando se descubre que los volúmenes de datos aumentaron de forma significativa para algunos usuarios u organizaciones.
El nivel de informe Detallado admite la generación asíncrona.
Para generar y descargar un informe en formato CSV o de archivo ZIP, realiza una de las siguientes tareas:
- Accede a la página Informes.
- Coloca el cursor sobre el informe que deseas descargar.
En la columna Modificado, haz clic en una de las siguientes opciones:
- El ícono de
o el ícono de 
(para un informe de resumen) El informe se guarda de forma síncrona en un archivo CSV o ZIP. - Enviar trabajo (para un informe detallado) Se inicia el trabajo asíncrono.
Supervisa el estado del trabajo en la columna Modificado.
El ícono de disco aparece cuando el informe está listo para descargarse:
- Una vez que se complete el trabajo, haz clic en el ícono de disco para descargar el informe.
- El ícono de
A continuación, se proporciona un ejemplo de un archivo CSV para un informe de facturación resumido.
Cómo editar un informe
Para editar un informe, siga estos pasos:
- Accede a la página Informes.
- Coloca el cursor sobre el informe que quieras editar y haz clic en
en el menú de acciones. - Actualiza la configuración del informe según sea necesario.
- Haz clic en Actualizar informe para guardar la configuración actualizada del informe.
Cómo borrar un informe
Para borrar un informe, sigue estos pasos:
- Accede a la página Informes.
- Coloca el cursor sobre el informe que deseas borrar.
- Haz clic en
en el menú de acciones.
Administra informes de monetización con la API
En las siguientes secciones, se describe cómo administrar informes de monetización con la API.
Configura un informe con la API
Para configurar un informe para toda la organización, envía una solicitud POST a /organizations/{org_name}/report-definitions.
Para configurar un informe para un desarrollador específico, envía una solicitud POST a /organizations/{org_name}/developers/{dev_id}/report-definitions, donde {dev_id} es la identificación del desarrollador.
Cuando realices la solicitud, deberás especificar el nombre y el tipo del informe. El tipo es uno de los siguientes: BILLING, REVENUE, VARIANCE (obsoleto) o PREPAID_BALANCE. Además, puedes especificar criterios en la propiedad mintCriteria que configuran aún más el informe. Puedes especificar una amplia variedad de criterios. Esto te brinda mucha flexibilidad para configurar el informe.
Estos son algunos de los criterios que puedes especificar:
- Mes de facturación del informe, en el caso de un informe de facturación o de saldo prepago
- En el caso de un informe de ingresos, el tipo de transacciones que se incluyen en el informe, como transacciones de compra, transacciones de cargo y reembolsos
- En el caso de un informe de saldo prepago, el desarrollador al que se aplica el informe
- En el caso de un informe de ingresos, los paquetes de productos de API (o paquetes de API), los productos, los planes de tarifas y las aplicaciones a los que se aplica el informe
- En el caso de un informe de ingresos o de varianza, la moneda aplicable para el informe
- Para los informes de facturación, saldo prepago o ingresos, indica si el informe es un resumen o un informe detallado.
- Para un informe de resumen de ingresos, incluye atributos de transacción personalizados en el informe.
Consulta Opciones de configuración de informes para obtener una lista completa de los criterios de los informes.
Por ejemplo, el siguiente comando crea un informe de ingresos que resume la actividad de transacciones del mes de julio de 2015. El informe incluye una variedad de tipos de transacciones especificados en la propiedad transactionTypes y se aplica específicamente al paquete de productos de la API de Payment y al producto de la API de Payment. Dado que no se especifica ningún desarrollador o aplicación en la definición del informe, este se aplica a todos los desarrolladores y aplicaciones. Además, como la propiedad currencyOption está establecida en LOCAL, cada línea del informe se mostrará con la moneda del plan de tarifas aplicable. Además, la propiedad groupBy especifica que las columnas del informe se agruparán en el siguiente orden: PACKAGE, PRODUCT, DEVELOPER, APPLICATION y RATEPLAN (incluye el nombre y el ID del plan de tarifas en el informe).
$ 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
El siguiente comando crea un informe de facturación detallado que muestra la actividad de un desarrollador DEV FIVE para junio de 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
Visualiza la configuración de los informes con la API
Puedes ver una configuración de informe específica o todas las configuraciones de informes de una organización. También puedes ver las configuraciones de informes de un desarrollador individual.
Para ver la configuración de un informe específico de una organización, envía una solicitud GET a /organizations/{org_name}/report-definitions/{report_definition_id}, donde {report_definition_id} es la identificación de la configuración del informe específico (el ID se devuelve en la respuesta cuando creas la configuración del informe). Por ejemplo:
$ 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
Para ver todas las configuraciones de informes de la organización, envía una solicitud GET a /organizations/{org_name}/report-definitions.
Puedes pasar los siguientes parámetros de consulta para filtrar y ordenar los resultados:
| Parámetro de consulta | Descripción |
|---|---|
all |
Es una marca que especifica si se deben devolver todos los paquetes de productos de API. Si se configura como false, la cantidad de paquetes de productos de API que se muestran por página se define con el parámetro de consulta size. El valor predeterminado es false. |
size |
Es la cantidad de paquetes de productos de API que se muestran por página. La configuración predeterminada es 20. Si el parámetro de búsqueda all se establece en true, este parámetro se ignora. |
page |
Número de la página que deseas devolver (si el contenido está paginado). Si el parámetro de consulta all se establece en true, este parámetro se ignora. |
sort |
Campo por el que se ordenará la información. Si el parámetro de búsqueda all se establece en true, este parámetro se ignora. La configuración predeterminada es UPDATED:DESC. |
Por ejemplo, la siguiente llamada devuelve las configuraciones de informes de la organización y limita la recuperación a un máximo de cinco configuraciones de informes:
$ 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 respuesta debería ser similar a la siguiente (solo se muestra una parte de la respuesta):
{ "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 }
Para ver la configuración de informes de un desarrollador específico, envía una solicitud GET a /organizations/{org_name}/developers/{dev_id}/report-definitions, donde {dev_id} es la identificación del desarrollador. Cuando realices la solicitud, puedes especificar los parámetros de consulta que se describieron anteriormente para filtrar y ordenar los datos.
Por ejemplo, la siguiente llamada devuelve las configuraciones de informes para un desarrollador específico y ordena la respuesta por nombre del informe:
$ 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
Actualiza la configuración de un informe con la API
Para actualizar la configuración de un informe, envía una solicitud PUT a /organizations/{org_name}/report-definitions/{report_definition_id}, donde {report_definition_id} es la identificación de la configuración del informe específico. Cuando realices la actualización, deberás especificar en el cuerpo de la solicitud los valores de configuración actualizados y el ID de la configuración del informe. Por ejemplo, la siguiente solicitud actualiza el informe a un informe de resumen (las propiedades actualizadas están destacadas):
$ 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 respuesta debería ser similar a la siguiente (solo se muestra una parte de la respuesta):
{ "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" }
Cómo borrar una configuración de informes con la API
Para borrar una configuración del informe, envía una solicitud DELETE a /organizations/{org_namer}/report-definitions/{report_definition_id}, donde {report_definition_id} es la identificación de la configuración del informe que se borrará.
Por ejemplo:
$ 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
Cómo generar un informe con la API
Después de configurar un informe, puedes generarlo en formato de archivo de valores separados por comas (CSV) para visualizarlo.
Para generar un informe, envía una solicitud POST a organizations/{org_id}/{report_type}, donde {report_type} especifica el tipo de informe que deseas generar. Los tipos son los siguientes:
billing-reportsrevenue-reportsprepaid-balance-reportsvariance-reports
Por ejemplo, para generar un informe de facturación, envía una solicitud POST a organizations/{org_name}/billing-reports.
En el cuerpo de la solicitud (para cualquier tipo de informe), especifica los criterios de búsqueda del informe. Usa las propiedades mintCriteria para especificar los criterios de búsqueda. Consulta Opciones de configuración de criterios para obtener más detalles.
Por ejemplo, la siguiente solicitud busca un informe de ingresos según varios criterios, como las fechas de inicio y finalización del informe, y los tipos de transacciones.
$ 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
Si se encuentra, el informe de ingresos se genera en formato de archivo CSV. A continuación, se proporciona un ejemplo del resultado del informe:
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,
Cómo incluir atributos personalizados del desarrollador en los informes de ingresos con la API
Solo para los informes de ingresos, puedes incluir atributos personalizados en el informe si el atributo personalizado está definido para el desarrollador. Defines atributos personalizados cuando agregas desarrolladores a tu organización, como se describe en Administra desarrolladores de aplicaciones.
Para incluir atributos personalizados en un informe de ingresos, envía una solicitud POST a organizations/{org_name}/revenue-reports y, luego, incluye el array devCustomAttributes en el cuerpo de la solicitud:
"devCustomAttributes": [
"custom_attribute1",
"custom_attribute2",
...
]Nota: No especifiques los atributos predefinidos MINT_* y ADMIN_* en el array devCustomAttributes.
Por ejemplo, el siguiente ejemplo incluye tres atributos personalizados, BILLING_TYPE, SFID y ORG_EXT, en el informe (si se definieron para el desarrollador):
$ 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
A continuación, se proporciona un ejemplo del resultado del informe que incluye valores para los dos atributos personalizados:
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,
Cómo registrar la actividad de las transacciones con la API
Puedes ver la actividad de las transacciones de una organización enviando una solicitud POST a /organizations/{org_name}/transaction-search. Cuando realices la solicitud, deberás especificar los criterios de recuperación. Estos son algunos de los criterios que puedes especificar:
- Es el ID de uno o más productos de API para los que se emitieron transacciones.
- Mes y año de facturación de las transacciones.
- Son los desarrolladores que emitieron la transacción.
- Es el tipo de transacción, como compra y tarifas de configuración.
- Estado de la transacción, como correcta o fallida.
Consulta Opciones de configuración de criterios para obtener una lista completa de los criterios.
Por ejemplo, la siguiente consulta devuelve las transacciones emitidas por un desarrollador específico para el mes de facturación de junio de 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
También puedes determinar qué aplicaciones, desarrolladores, paquetes de productos de API o productos de API tuvieron actividad de transacciones dentro de un período determinado. Puedes ver esta información por separado para cada tipo de objeto. Por ejemplo, puedes ver información específicamente sobre las aplicaciones que acceden a las APIs en tus paquetes de productos de API monetizados dentro de una fecha de inicio y una de finalización especificadas.
Para ver información sobre la actividad de las transacciones, envía una solicitud GET a uno de los siguientes recursos:
| Recurso | Muestra |
|---|---|
/organizations/{org_name}/applications-with-transactions |
Aplicaciones con transacciones |
/organizations/{org_name}/developers-with-transactions |
Desarrolladores con transacciones |
/organizations/{org_name}/products-with-transactions |
Productos con transacciones |
/organizations/{org_name}/packages-with-transactions |
Paquetes de productos de API (o paquetes de API) con transacciones |
Cuando envíes la solicitud, deberás especificar como parámetros de consulta una fecha de inicio y una fecha de finalización para el período. Por ejemplo, la siguiente solicitud devuelve los desarrolladores que realizaron transacciones durante el mes de agosto de 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 respuesta debería ser similar a la siguiente (solo se muestra una parte de la respuesta):
{ "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" }, ... ] }
Opciones de configuración de informes para la API
La API tiene disponibles las siguientes opciones de configuración de informes:
| Nombre | Descripción | Predeterminado | ¿Obligatorio? |
|---|---|---|---|
name |
Es el nombre del informe. |
N/A | Sí |
description |
Es una descripción del informe. |
N/A | No |
mintCriteria |
Son los criterios para configurar un informe. Consulta Opciones de configuración de criterios para obtener más detalles. |
N/A | No |
type |
Es el tipo de informe. El valor puede ser uno de los siguientes:
|
N/A | Sí |
Opciones de configuración de criterios
Las siguientes opciones de configuración están disponibles para los informes a través de la propiedad mintCriteria:
| Nombre | Descripción | Predeterminado | ¿Obligatorio? |
|---|---|---|---|
appCriteria |
Es el ID y la organización de una aplicación específica que se incluirá en el informe. Si no se especifica esta propiedad, se incluirán todas las aplicaciones en el informe. |
N/A | No |
billingMonth |
Nota: Esta propiedad no es válida para los informes de ingresos. Mes de facturación del informe, como JULIO. |
N/A | Sí |
billingYear |
Nota: Esta propiedad no es válida para los informes de ingresos. Año de facturación del informe, como 2015. |
N/A | Sí |
currCriteria |
Es el ID y la organización de una moneda específica que se incluirá en el informe. Si no se especifica esta propiedad, se incluirán todas las monedas admitidas en el informe. |
N/A | No |
currencyOption |
Moneda para el informe. Estos son algunos de los valores válidos:
|
N/A | No |
devCriteria |
ID de desarrollador (dirección de correo electrónico) y nombre de la organización de un desarrollador específico que se incluirá en el informe. Si no se especifica esta propiedad, se incluirán todos los desarrolladores en el informe. Por ejemplo: "devCriteria":[{
"id":"RtHAeZ6LtkSbEH56",
"orgId":"my_org"}
]
|
N/A | No |
devCustomAttributes |
Nota: Esta propiedad solo se aplica a los informes de ingresos. Son los atributos personalizados que se incluirán en el informe, si se definieron para un desarrollador. Por ejemplo: "devCustomAttributes": [
"custom_attribute1",
"custom_attribute2",
...
]Nota: No especifiques los atributos predefinidos |
N/A | No |
fromDate |
Nota: Esta propiedad solo se aplica a los informes de ingresos, variaciones y actividad de transacciones. Fecha de inicio del informe en UTC. |
N/A | Es obligatorio para los informes de ingresos, pero no para otros tipos de informes. |
groupBy |
Es el orden en que se agrupan las columnas en el informe. Estos son algunos de los valores válidos:
|
N/A | No |
monetizationPackageId |
Es el ID de uno o más paquetes de productos de API que se incluirán en el informe. Si no se especifica esta propiedad, se incluyen todos los paquetes de productos de API en el informe. Nota: Esta propiedad no es válida cuando se visualiza la actividad de la transacción ( |
N/A | No |
pkgCriteria |
Es el ID y la organización de un paquete de productos de API específico que se incluirá en el informe. Si no se especifica esta propiedad, se incluyen todos los paquetes de productos de API en el informe. Esta propiedad se puede especificar en lugar de la propiedad Nota: Esta propiedad no es válida cuando se visualiza la actividad de la transacción ( |
N/A | No |
prevFromDate |
Nota: Esta propiedad solo se aplica a los informes de varianza. Fecha de inicio de un período anterior en UTC. Se usa para crear un informe de un período anterior y compararlo con un informe actual. |
N/A | No |
prevToDate |
Nota: Esta propiedad solo se aplica a los informes de varianza. Fecha de finalización de un período anterior en UTC. Se usa para crear un informe de un período anterior y compararlo con un informe actual. |
N/A | No |
prodCriteria |
Es el ID y la organización de un producto de API específico que se incluirá en el informe. Si no se especifica esta propiedad, se incluyen todos los productos de API en el informe. Esta propiedad se puede especificar en lugar de la propiedad Nota: Esta propiedad no es válida cuando se visualiza la actividad de la transacción ( |
N/A | No |
productIds |
Es el ID de uno o más productos de API que se incluirán en el informe. Si no se especifica esta propiedad, se incluyen todos los productos de API en el informe. Los IDs de los productos de API se deben especificar como |
N/A | No |
pricingTypes |
Es el tipo de precio del plan de tarifas que se incluirá en el informe. Estos son algunos de los valores válidos:
Si no se especifica esta propiedad, se incluirán en el informe los planes de tarifas de todos los tipos de precios. |
N/A | No |
ratePlanLevels |
Es el tipo de plan de tarifas que se incluirá en el informe. Estos son algunos de los valores válidos:
Si no se especifica esta propiedad, se incluirán en el informe tanto los planes de tarifas estándar como los específicos para desarrolladores. |
N/A | No |
showRevSharePct |
Es una marca que especifica si el informe muestra los porcentajes de reparto de ingresos. Los valores válidos incluyen los siguientes:
|
N/A | No |
showSummary |
Es una marca que especifica si el informe es un resumen. Estos son algunos de los valores válidos:
|
N/A | No |
showTxDetail |
Nota: Esta propiedad solo se aplica a los informes de ingresos. Es una marca que especifica si el informe muestra detalles a nivel de la transacción. Los valores válidos incluyen los siguientes:
|
N/A | No |
showTxType |
Es una marca que especifica si el informe muestra el tipo de cada transacción. Los valores válidos incluyen lo siguiente:
|
N/A | No |
toDate |
Nota: Esta propiedad solo se aplica a los informes de ingresos, variaciones y actividad de transacciones. Fecha de finalización del informe en UTC. El informe incluye los datos recopilados hasta el final del día anterior a la fecha especificada. Los datos de informes recopilados en la fecha de finalización especificada se excluirán del informe. Por ejemplo, si quieres que un plan de tarifas venza el 31 de diciembre de 2016, debes establecer el valor de toDate en 2017-01-01. En este caso, el informe incluirá datos hasta el final del día del 31 de diciembre de 2016, pero se excluirán los datos del 1 de enero de 2017. |
N/A | Es obligatorio para los informes de ingresos, pero no para otros tipos de informes. |
transactionStatus |
Es el estado de las transacciones que se incluirán en el informe. Estos son algunos de los valores válidos:
|
N/A | No |
transactionCustomAttributes |
Son atributos de transacción personalizados que se incluirán en los informes de ingresos resumidos. Debes habilitar esta función en tu organización. Consulta Cómo incluir atributos de transacción personalizados en los informes de resumen de ingresos. |
N/A | No |
transactionTypes |
Es el tipo de transacciones que se incluirán en el informe. Estos son algunos de los valores válidos:
Si no se especifica esta propiedad, se incluirán todos los tipos de transacciones en el informe. |
N/A | No |