Monetization Services es una extensión de Apigee Edge, por lo que no se ejecuta como un proceso independiente. Se ejecuta en cualquier configuración existente de Apigee Edge, con la excepción de la configuración All-In-One (AIO) . No puedes instalar Monetization Services en una configuración de AIO.
Requisitos de monetización
- Si instalas Monetization en una topología de Edge que usa varios nodos de Management Server nodes, como una instalación de 13 nodos, debes instalar ambos nodos de Edge Management Server nodes before installing Monetization.
- Para instalar Monetization en Edge, donde la instalación de Edge tiene varios nodos de Postgres, los nodos de Postgres deben configurarse en el modo principal/en espera. No puedes instalar Monetization en Edge si tienes varios nodos principales de Postgres. Para obtener más información, consulta Configura la replicación principal-en espera para Postgres.
- Monetization no está disponible con la configuración All-In-One (AIO).
Descripción general de instalación
En los siguientes pasos, se muestra cómo agregar Monetization Services en una instalación existente de Apigee Edge:
- Usa la utilidad
apigee-setuppara actualizar el nodo de Apigee Management Server y habilitar Monetization Services, por ejemplo, la administración de catálogos, la configuración de límites y notificaciones configuración, facturación e informes.Si tienes varios nodos de Management Server, como una instalación de 13 nodos, debes instalar ambos nodos de Edge Management Server antes de instalar Monetization.
- Usa la utilidad
apigee-setuppara actualizar el Apigee Message Processor y habilitar los componentes del entorno de ejecución de los Monetization Services, por ejemplo, la política de registro de transacciones y la aplicación de límites. Si tienes varios Message Processors, instala Monetization en todos ellos. - Realiza el proceso de incorporación de Monetization para tus organizaciones de Edge.
- Configura el portal de Apigee Developer Services (o simplemente, el portal) para admitir la monetización. Para obtener más información, consulta Configura la monetización en el portal para desarrolladores.
Crea un archivo de configuración silenciosa para Monetization
A continuación, se muestra un archivo de configuración silenciosa de ejemplo para una instalación de Monetization. Edita este archivo según sea necesario para tu configuración. Usa la opción -f para setup.sh para incluir este archivo.
# Edge configuration properties # Specify IP address or DNS name of node. IP1=192.168.1.1 # Management Server, SymasLDAP, New Edge UI, ZooKeeper, Cassandra IP2=192.168.1.2 # ZooKeeper, Cassandra IP3=192.168.1.3 # ZooKeeper, Cassandra IP4=192.168.1.4 # Router, Message Processor IP5=192.168.1.5 # Router, Message Processor IP6=192.168.1.6 # Qpid IP7=192.168.1.7 # Qpid IP8=192.168.1.8 # Postgres IP9=192.168.1.9 # Postgres # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost. HOSTIP=$(hostname -i) # Edge sys admin credentials ADMIN_EMAIL=your@email.com APIGEE_ADMINPW=yourPassword # If omitted, you are prompted for it. # Specify the Management Server port. APIGEE_PORT_HTTP_MS=8080 # # Monetization configuration properties. # # Postgres credentials from Edge installation. PG_USER=apigee # Default from Edge installation PG_PWD=postgres # Default from Edge installation # Specify Postgres server. MO_PG_HOST="$IP8" # Only specify one Postgres node. # Create a Postgres user for Monetization. # Default username is "postgre". # If you specify a different user, that user must already exist. MO_PG_USER=postgre MO_PG_PASSWD=moUserPWord # Specify one ZooKeeper host. # Ensure this is a ZooKeeper leader node in a multi-datacenter environment. ZK_HOSTS="$IP2" # Specify Cassandra information. # Ensure CASS_HOSTS is set to the same value as when you installed Edge. # Must use IP addresses for CASS_HOSTS, not DNS names. CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1" # Default is "Apigee", unless it was changed during Edge install. CASS_CLUSTERNAME=Apigee # Cassandra uname/pword required only if you enabled Cassandra authentication. # If your password uses special characters, wrap it in single quotes. # CASS_USERNAME= # CASS_PASSWORD= # Specify the region. # Default is dc-1 unless you are in a multi-datacenter environment. REGION=dc-1 # If your Edge config file did not specify SMTP information, add it. # Monetization requires an SMTP server. SMTPHOST=smtp.gmail.com SMTPPORT=465 SMTPUSER=your@email.com SMTPPASSWORD=yourEmailPassword SMTPSSL=y SMTPMAILFROM="My Company <myco@company.com>"
Notas:
- Si tu archivo de configuración de Edge no especificó información de SMTP, agrégala. Monetization requiere un servidor SMTP.
- En una instalación de un solo centro de datos, todos los nodos de ZooKeeper se configuran como líderes de forma predeterminada. Cuando instalas Edge en varios centros de datos, algunos nodos de ZooKeeper se configuran como observadores. Asegúrate de que la propiedad ZK_HOSTS anterior especifique un nodo líder en una instalación de varios centros de datos.
- Si habilitas la autenticación de Cassandra, puedes pasar el nombre de usuario y la contraseña de Cassandra
con las siguientes propiedades:
CASS_USERNAME CASS_PASSWORD
Integra Monetization Services con todos los Management Servers
Usa el siguiente procedimiento para integrar la monetización en los nodos de Management Server.
- Si instalas Monetization en una topología de Edge que usa varios nodos de Management Server nodes, como una instalación de 13 nodos, asegúrate de haber instalado ambos nodos de Management Server nodes antes de instalar Monetization.
- En el nodo de Management Server, ejecuta la secuencia de comandos de configuración:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
La opción
-p moespecifica que se debe integrar la monetización.El archivo de configuración debe ser accesible o legible para el usuario "apigee".
- Si instalas Monetization en varios nodos de Management Server, repite el paso 2 en el segundo nodo de Management Server.
Si la configuración es correcta, se crea un esquema RDBMS para Monetization Services en la base de datos de PostgreSQL. Esto completa la integración de Monetization Services y sus componentes asociados con Postgres Server.
Integra Monetization Services con todos los Message Processors
Usa el siguiente procedimiento para integrar la monetización en todos los nodos de Message Processor.
- En el primer nodo de Message Processor, en el símbolo del sistema, ejecuta la secuencia de comandos de configuración:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
La opción
-p moespecifica que se debe integrar la monetización.El archivo de configuración debe ser accesible o legible para el usuario "apigee".
- Repite este procedimiento en todos los nodos de Message Processor.
Si la configuración es correcta, el Message Processor se actualiza con Monetization Services. Esto completa la integración de Monetization Services y sus componentes asociados con los Message Processors.
Incorporación de monetización
Para crear una organización nueva y habilitar la monetización, haz lo siguiente:
- Crea la organización como lo harías con cualquier organización nueva. Para obtener más información, consulta Incorpora una organización.
- Usa la API de aprovisionamiento de monetización como se describe en Habilita la monetización para una organización. Para ello, debes tener privilegios de administrador del sistema.
La próxima vez que accedas a la IU de New Edge, verás la entrada Monetización en el menú de nivel superior de la organización:

Para configurar el portal para admitir la monetización, consulta Configura la monetización en el portal para desarrolladores.
Agrega un nodo de Management Server a una instalación de Monetization
Si agregas un Management Server a una instalación existente de Edge, debes asegurarte de agregar servicios de Monetization al nuevo Management Server y configurar todos los Management Servers para que puedan comunicarse.
Para agregar un Management Server, haz lo siguiente:
- Instala el nuevo Management Server.
- Instala Monetization en el nuevo Management Server con el siguiente comando:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f /opt/silent.conf
Configuración adicional
Proporciona documentos de facturación como archivos PDF
Monetization muestra documentos de facturación a los usuarios finales en formato HTML. Para proporcionar documentos de facturación como archivos PDF, puedes integrar Monetization con un sistema de facturación que proporcione generación de PDF o licenciar una biblioteca de PDF de terceros compatible.
Configura los ajustes de la organización
Para agregar o actualizar atributos de la organización, puedes usar una solicitud PUT, como se muestra en el siguiente
ejemplo:
curl -u SYS_ADMIN_EMAIL:SYS_ADMIN_PASSWORD \ -v http://ms_IP:8080/v1/organizations/orgId -d 'org object with attributes' -X PUT
Monetization responde con la configuración de la organización. Por ejemplo:
{
...
"displayName": "Orgnization name",
"name": "org4",
"properties": {
"property": [
...
{
"name": "MINT_CURRENCY",
"value": "USD"
},
{
"name": "MINT_COUNTRY",
"value": "US"
},
{
"name": "MINT_TIMEZONE",
"value": "GMT"
}
]
}
}En la siguiente tabla, se enumeran los atributos a nivel de la organización que están disponibles para configurar una organización de Mint.
| Atributos | Descripción |
|---|---|
MINT_TAX_MODEL
|
Los valores aceptados son "DISCLOSED", "UNDISCLOSED", "HYBRID" (el valor predeterminado es nulo). |
MINT_CURRENCY
|
Código de moneda ISO (el valor predeterminado es nulo). |
MINT_TAX_NEXUS
|
Nexo fiscal (el valor predeterminado es nulo). |
MINT_DEFAULT_PROD_TAX_CATEGORY
|
Categoría fiscal predeterminada del producto (el valor predeterminado es nulo). |
MINT_IS_GROUP_ORG
|
Organización del grupo IS (el valor predeterminado es "false"). |
MINT_HAS_BROKER
|
Tiene un agente (el valor predeterminado es falso). |
MINT_TIMEZONE
|
Zona horaria (el valor predeterminado es nulo). |
MINT_TAX_ENGINE_EXTERNAL_ID
|
ID del motor de impuestos (el valor predeterminado es nulo). |
MINT_COUNTRY
|
País de la organización (el valor predeterminado es nulo). |
MINT_REG_NO
|
Número de registro de la organización. El Reino Unido proporciona un número diferente al ID fiscal (el valor predeterminado es nulo). |
MINT_BILLING_CYCLE_TYPE
|
"PRORATED", "CALENDAR_MONTH" (el valor predeterminado es "CALENDAR_MONTH"). |
MINT_SUPPORTED_BILLING_TYPE
|
"PREPAID"/"POSTPAID"/"BOTH" (el valor predeterminado es "PREPAID"). |
MINT_IS_SEPARATE_INV_FOR_FEES
|
Indica si se debe generar una factura de tarifas independiente (el valor predeterminado es "false"). |
MINT_ISSUE_NETTING_STMT
|
Indica si se debe emitir un estado de compensación (el valor predeterminado es "false"). |
MINT_NETTING_STMT_PER_CURRENCY
|
Indica si se debe generar un estado de compensación por moneda (el valor predeterminado es "false"). |
MINT_HAS_SELF_BILLING
|
Indica si la organización tiene facturación automática (el valor predeterminado es "false"). |
MINT_SELF_BILLING_FOR_ALL_DEV
|
Indica si la organización tiene facturación automática para todos los desarrolladores (el valor predeterminado es "false"). |
MINT_HAS_SEPARATE_INV_FOR_PROD
|
Indica si la organización tiene una factura independiente por producto (el valor predeterminado es "false"). |
MINT_HAS_BILLING_ADJUSTMENT
|
Indica si la organización admite ajustes de facturación (el valor predeterminado es "false"). |
features.isMonetizationEnabled
|
La IU de New Edge lo usa para mostrar el menú específico de monetización (el valor predeterminado es "false"). |
ui.config.isOperator
|
La IU de New Edge lo usa para mostrar el proveedor como operador en comparación con la organización (el valor predeterminado es "true"). |
Para configurar los parámetros de la organización empresarial con la IU de New Edge, consulta Comienza a usar la monetización.
Límites de monetización
Para aplicar los límites de monetización, adjunta la política de verificación de límites de monetización a los proxies de API. En particular, la política se activa en las siguientes condiciones:
- El desarrollador que accede a la API monetizada no está registrado o no se suscribió al plan de tarifas.
- El desarrollador excedió el volumen de transacciones del plan de tarifas suscrito.
- Se alcanzó el saldo prepago de la cuenta del desarrollador o el límite de crédito pospago.
La política de verificación de límites de monetización genera fallas y bloquea las llamadas a la API en situaciones como las mencionadas anteriormente. La política extiende la política Raise Fault y puedes personalizar el mensaje que se muestra. Las condiciones aplicables se derivan de las variables comerciales.
Para obtener más información, consulta Aplica límites de monetización en proxies de API.