Cómo instalar servicios de monetización

Edge para la nube privada v. 4.16.09

Los servicios de monetización son una extensión de Apigee Edge, por lo que no se ejecutan como un proceso independiente. Se ejecuta en cualquier configuración existente de Apigee Edge.

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 en espera principal para Postgres.

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 de Apigee Management Server y habilitar los servicios de monetización, por ejemplo, administración de catálogos, configuración de límites y notificaciones, informes y facturación.

    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 la aplicación de límites. 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 a fin de admitir la monetización Para obtener más información, consulta http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

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.

Nota: Por lo general, debes agregar estas propiedades al mismo archivo de configuración que usaste para instalar Edge, como se muestra en Instala componentes de Edge en un nodo.

# 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. 
# 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
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 mediante 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.

  1. 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.
  2. 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 la integración de la monetización.

    El usuario de “apigee” debe poder acceder o leer el archivo de configuración.
  3. 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.

Integra los servicios de monetización en todos los procesadores de mensajes

Usa el siguiente procedimiento para integrar la monetización en todos los nodos de Message Processor.

  1. 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 la integración de la monetización.

    El usuario de “apigee” debe poder acceder o leer el archivo de configuración.
  2. 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 monetización

Para crear una organización nueva con la monetización habilitada, primero debes crearla como lo harías con cualquier organización nueva. Para obtener más información, consulta Integra una organización.

Integración adicional para habilitar la monetización para una organización

Para completar la integración de monetización de una organización, debes hacer lo siguiente:

  1. Crea el grupo de monetización: mxgroup.
  2. Agrega Qpid al grupo.
  3. Habilitar la monetización para la organización
  4. Habilitar la configuración de notificaciones para la organización
  5. Repite este proceso para todas las organizaciones en las que quieras habilitar la monetización.

Usa el comando enable-monetization para realizar todas estas tareas. Esta secuencia de comandos toma un archivo de configuración que contiene las siguientes propiedades:

MSIP=IPorDNSofManagementServer
APIGEE_PORT_HTTP_MS=8080    # Default is 8080.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=yourPassword    # If omitted, you are prompted for it.
# Must use IP addresses for CASS_HOSTS, not DNS names.
CASS_HOSTS="$IP1:1,1 $IP2:1,1 $IP3:1,1"
# Space-separated list IP/DNS names of all Qpid nodes in the data center being configured.
QPID_HOST="$IP6 $IP7"    
QPID_PORT=8083     # Default is 8083.
REGION=dc-1
ORG_NAME=myorg    # The Edge org where you want to enable monetization. 
MX_GROUP=mxgroup    # Default Monetization group.

Notas:

  • Configura CASS_HOSTS y REGION en los mismos valores que usaste cuando instalaste la monetización.
  • Si quieres habilitar la monetización en la configuración de varios centros de datos, haz lo siguiente:
    • Debes repetir el proceso de integración en el servidor de administración en cada centro de datos.
    • El archivo de configuración solo debe mostrar los nodos de Qpid en el centro de datos que se está configurando.

Para ejecutar la secuencia de comandos, sigue estos pasos:

  1. Invoca la secuencia de comandos:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile


    El usuario de “apigee” debe poder acceder al archivo de configuración o leerlo.

    Si tienes varios servidores de administración, solo debes ejecutar esta secuencia de comandos en uno de ellos.

    Esta secuencia de comandos replica la organización, los productos, los desarrolladores y las aplicaciones de la base de datos Cassandra a la base de datos PostgreSQL de Monetization. Después de instalar correctamente los servicios de monetización, los datos se sincronizan automáticamente.
  2. Repite este procedimiento para cada organización en la que desees habilitar la Monetización.
  3. Si estás en un entorno de varios centros de datos, repite este proceso en el servidor de administración del otro centro de datos. Asegúrate de que el archivo de configuración solo enumere los nodos de Qpid en el centro de datos que se está configurando.

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:

Configura el portal de servicios para desarrolladores

Si desea configurar el portal de Servicios para desarrolladores y que admita la monetización, consulte http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

Agregar 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:

  1. Instala el nuevo servidor de administración.
  2. Instala la Monetización en el nuevo servidor de administración.
  3. En el servidor de administración original, llama a lo siguiente:
    > /opt/apigee/apigee-service/bin/apigee-service perímetro-mint-management-server mint-configure-mgmt-cluster
  4. Reinicia el servidor de administración original:
    > /opt/apigee/apigee-service/bin/apigee-service Edge-management-server restart
  5. En el servidor de administración nuevo, llama a lo siguiente:
    >/opt/apigee/apigee-service/bin/apigee-service perimetral-mint-management-server mint-configure-mgmt-cluster
  6. Reinicia el servidor de administración nuevo:
    >/opt/apigee/apigee-service/bin/apigee-service Edge-management-server restart

Configuración adicional

Proporciona 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.

Define la configuración de la organización

Configuración de backend: En la siguiente tabla, se enumeran los atributos de nivel de organización que están disponibles para configurar una organización de creación. Puedes usar una llamada PUT para agregar o actualizar estos atributos, como se muestra a continuación:

> curl -u ${ADMIN_EMAIL}:${ADMINPW} -v http://<management-ip>:8080/v1/organizations/{orgId} -d '{org object with attributes}' -X PUT

Por ejemplo, el resultado del comando CURL anterior se verá de la siguiente manera:

{
...
    "displayName": "Orgnization name",
    "name": "org4",
    "properties": {
        "property": [
...
            {
                "name": "MINT_CURRENCY",
                "value": "USD"
            },
            {
                "name": "MINT_COUNTRY",
                "value": "US"
            },
            {
                "name": "MINT_TIMEZONE",
                "value": "GMT"
            }
        ]
    }
}

Attributes

Descripción

MINT_TAX_MODEL

Los valores aceptados son DISCLOSED y

NO DIVULGADO, 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 falso)

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 falso).

MINT_ISSUE_NETTING_STMT

Indica si se debe emitir una declaración de compensación (el valor predeterminado es falso).

MINT_NETTING_STMT_PER_CURRENCY

Indica si la sentencia de balance se debe generar según la moneda (el valor predeterminado es falso)

MINT_HAS_SELF_BILLING

Indica si la organización cuenta con facturación propia (el valor predeterminado es falso).

MINT_SELF_BILLING_FOR_ALL_DEV

Indica si la organización cuenta con facturación propia para todos los desarrolladores(el valor predeterminado es falso).

MINT_HAS_SEPARATE_INV_FOR_PROD

Indica si la organización tiene facturas independientes por producto (el valor predeterminado es falso).

MINT_HAS_BILLING_ADJUSTMENT

Indica si la organización admite ajustes de facturación (el valor predeterminado es falso).

features.isMonetizationEnabled

La IU de administración lo usa para mostrar el menú específico de monetización (el valor predeterminado es falso)

ui.config.isOperator

La IU de administración lo usa para mostrar el proveedor como el operador frente a la organización

(el valor predeterminado es verdadero)

Para definir la configuración de la organización empresarial mediante la IU de administración, consulta http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.

Nota: Si usas las funciones de Límites y Notificaciones de Servicios de Monetización, indícales a tus desarrolladores que adjunten una Política de Límites en el flujo de proxy después de la política de validación de tokens de acceso.

La política de límites es una política explícita diseñada para bloquear una llamada a la API si se alcanza un límite determinado. La política verifica los límites de la empresa y genera una falla si alguno de los límites excede el valor configurado. Esta es una extensión de la política de aumento de fallas, pero las condiciones derivan de variables comerciales.

Hay una plantilla de IU disponible en la IU de administración para desarrolladores de proxy. El desarrollador de proxy debe adjuntar una política de creación en el flujo de mensajes. Después de que se ejecute esta política, se generará la falla con la respuesta de falla según la política. Si se configura ContinueOnError como verdadero, no se generará el error y se establecerán las variables de flujo "mint.limitsViolated", "mint.isDeveloperSuspended" y "mint.limitsPolicyError" que podrían utilizarse para un mayor manejo de excepciones si es necesario.