Los servicios de monetización son una extensión de Apigee Edge, por lo que no se ejecutan como un proceso independiente. Se ejecuta dentro de cualquier configuración existente de Apigee Edge, a excepción de la configuración All-in-One (AIO). No puedes instalar servicios de monetización con una configuración de AIO.
Requisitos de monetización
- Si instalas la monetización en una topología perimetral que usa varios nodos del servidor de administración, como una instalación de 13 nodos, debes instalar ambos nodos del servidor de administración perimetral antes de instalar la monetización.
- Para instalar la monetización en Edge, en los que la instalación de Edge tiene varios nodos de Postgres, estos deben configurarse en modo principal o de espera. No puedes instalar la monetización en Edge si tienes varios nodos principales de Postgres. Si deseas obtener más información, consulta Configura la replicación de instancia principal en espera para Postgres.
- La monetización no está disponible con la configuración Todo en uno (AIO).
Descripción general de instalación
En los siguientes pasos, se muestra cómo agregar servicios de monetización en una instalación existente de Apigee Edge:
- Usa la utilidad
apigee-setup
para actualizar el nodo del servidor de administración de Apigee a fin de habilitar los servicios de monetización, por ejemplo, la administración de catálogos, la configuración de límites y notificaciones, la facturación y los informes.Si tienes varios nodos del servidor de administración, como una instalación de 13 nodos, debes instalar ambos nodos del servidor de administración perimetral antes de instalar la monetización.
- Usa la utilidad
apigee-setup
para actualizar Apigee Message Processor a fin de habilitar los componentes del entorno de ejecución de los servicios de monetización, por ejemplo, la política de registro de transacciones y limitar la aplicación forzosa. Si tienes varios procesadores de mensajes, instala la monetización en todos. - Realiza el proceso de integración de la monetización para tus organizaciones de Edge.
- Configurar el portal de servicios para desarrolladores de Apigee (o simplemente, el portal) para admitir la monetización Para obtener más información, consulta Cómo configurar la monetización en el Portal para desarrolladores.
Crear un archivo de configuración silencioso para la monetización
A continuación, se muestra un ejemplo de un archivo de configuración silencioso para una instalación de monetización. 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, OpenLDAP, 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 el archivo de configuración de Edge no especificó información de SMTP, agrégala. La monetización requiere un servidor SMTP.
- En una sola instalación de 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
.
Integrar los servicios de monetización con todos los servidores de administración
Usa el siguiente procedimiento para integrar la monetización en los nodos del servidor de administración.
- Si instalas la monetización en una topología perimetral que usa varios nodos del servidor de administración, como una instalación de 13 nodos, asegúrate de haber instalado ambos nodos del servidor de administración antes de instalar la monetización.
- En el nodo del servidor de administración, ejecuta la secuencia de comandos de configuración:
/opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile
La opción
-p mo
especifica que se debe integrar la monetización.El usuario de “apigee” debe poder acceder o leer el archivo de configuración.
- Si instalas la Monetización en varios nodos del Servidor de administración, repite el paso 2 en el segundo nodo del Servidor de administración.
Cuando la configuración se realiza de forma correcta, se crea un esquema RDBMS para los servicios de monetización en la base de datos de PostgreSQL. Esto completa la integración de los servicios de monetización y sus componentes asociados con el servidor de Postgres.
Integrar los servicios de monetización con todos los procesadores de mensajes
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 mo
especifica que se debe integrar la monetización.El usuario de “apigee” debe poder acceder o leer el archivo de configuración.
- Repite este procedimiento en todos los nodos de Message Processor.
Si se configura correctamente, el procesador de mensajes se actualizará con los servicios de monetización. Esto completa la integración de los servicios de monetización y sus componentes asociados con los procesadores de mensajes.
Integración de la monetización
Sigue estos pasos para crear una organización nueva y habilitar la monetización:
- Crea la organización como lo harías con cualquier organización nueva. Para obtener más información, consulta Integra una organización.
- Usa la API de aprovisionamiento de monetización como se describe en Habilita la monetización para una organización. Para hacerlo, debes tener privilegios de administrador del sistema.
La próxima vez que accedas a la IU de Edge, verás la entrada Monetización en el menú de nivel superior de la organización:
Si quieres configurar el portal para admitir la monetización, consulta Cómo configurar la monetización en el portal para desarrolladores.
Agrega un nodo del servidor de administración a una instalación de monetización
Si agregas un servidor de administración a una instalación perimetral existente, debes asegurarte de agregar los servicios de monetización al nuevo servidor de administración y configurar todos los servidores de administración para que puedan comunicarse.
Para agregar un servidor de administración, haz lo siguiente:
- Instala el nuevo servidor de administración.
- Instala la Monetización en el nuevo servidor de administración.
- En el servidor de administración original, llama al siguiente comando:
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- Reinicia el servidor de administración original:
/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
- En el nuevo servidor de administración, llama al siguiente comando:
/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
- Reinicia el servidor de administración nuevo:
/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
Configuración adicional
Proporciona los documentos de facturación como archivos PDF
La monetización muestra los documentos de facturación a los usuarios finales en formato HTML. Para proporcionar documentos de facturación como archivos PDF, puedes integrar la monetización en 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
La monetización 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 creación.
Atributos | Descripción |
---|---|
MINT_TAX_MODEL
|
Los valores aceptados son "DISCLOSED", "UNDISCLOSED" y "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
|
No funciona (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
|
El número de registro de la organización, Reino Unido, proporciona un número diferente al de 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 con una tarifa por separado (el valor predeterminado es "false"). |
MINT_ISSUE_NETTING_STMT
|
Indica si se debe emitir un resumen de compensación (el valor predeterminado es "false"). |
MINT_NETTING_STMT_PER_CURRENCY
|
Indica si la sentencia de balance se debe generar según la moneda (el valor predeterminado es "false") |
MINT_HAS_SELF_BILLING
|
Indica si la organización cuenta con facturación propia (el valor predeterminado es "false"). |
MINT_SELF_BILLING_FOR_ALL_DEV
|
Indica si la organización cuenta con facturación propia para todos los desarrolladores (el valor predeterminado es “false”). |
MINT_HAS_SEPARATE_INV_FOR_PROD
|
Indica si la organización tiene facturas independientes 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 administración lo usa para mostrar el menú específico de monetización (el valor predeterminado es "false") |
ui.config.isOperator
|
La IU de administración lo usa para mostrar el proveedor como Operador frente a Organización (el valor predeterminado es “verdadero”) |
Para definir la configuración de la organización empresarial con la IU de administración, consulta Comienza a usar la monetización.
Límites de monetización
Para aplicar límites de monetización, adjunta la política de verificación de límites de monetización a los proxies de API. Específicamente, 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 superó el volumen de transacciones del plan de tarifas al que se suscribió.
- Se alcanzó el saldo prepagado 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 que se mencionaron anteriormente. La política extiende la política Levantar errores, y puedes personalizar el mensaje que se muestra. Las condiciones aplicables derivan de variables de negocios.
Para obtener más información, consulta Aplica límites de monetización en proxies de API.