Cómo instalar servicios de monetización

Edge for Private Cloud v4.19.01

Los servicios de monetización son una extensión de Apigee Edge, por lo que no se ejecutan como un el proceso de administración de recursos. Se ejecuta dentro de cualquier configuración de Apigee Edge existente, excepto la del todo en uno (AIO). configuración. No puedes instalar servicios de monetización en una configuración de AIO.

Requisitos para la monetización

  • Si instalas la monetización en una topología perimetral que usa varios servidores de administración como una instalación de 13 nodos, debes instalar ambos nodos del servidor de administración perimetral antes de instalar Monetización.
  • Para instalar la monetización en Edge, cuando la instalación de Edge tenga varios nodos de Postgres, sigue estos pasos: Los nodos de Postgres se deben configurar en modo Principal/En espera. No puedes instalar la monetización 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.
  • La monetización no está disponible con la configuración de todo en uno (AIO).

Descripción general de instalación

En los siguientes pasos, se muestra cómo agregar servicios de monetización a un entorno de Apigee Edge existente instalación:

  • Usa la utilidad apigee-setup para actualizar el nodo del servidor de administración de Apigee a Habilitar los Servicios de Monetización; por ejemplo, la administración de catálogos, límites y notificaciones la configuración, la facturación y los informes.

    Si tienes varios nodos de un 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 el apigee-setup para actualizar Apigee Message Processor y habilitar los componentes del entorno de ejecución de la Servicios de Monetización, por ejemplo, la política de registro de transacciones y la aplicación de límites. Si si tiene varios procesadores de mensajes, instale la monetización en todos ellos.
  • Realizar el proceso de integración a la monetización para tus organizaciones perimetrales.
  • 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 Configura 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 silenciosa para una instalación de monetización. Editar esto archivo según sea necesario para tu configuración. Usa la opción -f en 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.
# 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 en el archivo de configuración de Edge no se especificó información de SMTP, agrégalo. La monetización requiere una servidor SMTP.
  • En una única instalación de centro de datos, todos los nodos de ZooKeeper se configuran de forma predeterminada como y líderes de la industria. Cuando instales Edge en varios centros de datos, algunos nodos de ZooKeeper configurar 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 a 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 servidores de administración como una instalación de 13 nodos, y asegúrate de haber instalado ambos 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 que se debe integrar la monetización.

    El archivo de configuración debe ser accesible y legible por el “Apigee” usuario.

  3. Si instalas 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 es exitosa, se crea un esquema RDBMS para los servicios de monetización en el Base de datos de PostgreSQL. Esto completa la integración de los Servicios de Monetización y sus servicios componentes con Postgres Server.

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

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

  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 que se debe integrar la monetización.

    El archivo de configuración debe ser accesible y legible por el “Apigee” usuario.

  2. Repite este procedimiento en todos los nodos de Message Processor.

Si la configuración es exitosa, el Procesador de mensajes se actualiza con Servicios de monetización. Esta completa la integración de los Servicios de Monetización y sus componentes asociados con el Mensaje Procesadores.

Integración de monetización

Sigue estos pasos para crear una organización nueva y habilitar la monetización:

  1. Crea la organización como lo harías con cualquier organización nueva. Para obtener más información, consulta Integra una organización.
  2. Usa la API de aprovisionamiento de monetización como se describe en Habilitar la monetización de una organización. Para hacerlo, debes tener un administrador del sistema privilegios.

La próxima vez que accedas a la IU de Edge, verás la entrada Monetization en el menú de nivel superior de la organización:

Si deseas configurar el portal para que admita la monetización, consulta Configurar la monetización en el portal para desarrolladores.

Agrega un nodo de 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, sigue estos pasos:

  1. Instala el servidor de administración nuevo.
  2. Instalar 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 edge-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, realiza una llamada al siguiente código: 
    /opt/apigee/apigee-service/bin/apigee-service edge-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 documentos de facturación a los usuarios finales en formato HTML. Para proporcionar la facturación, sigue estos pasos: documentos como archivos PDF, puede integrar la Monetización con un sistema de facturación que proporciona generar una licencia o obtener la licencia de una biblioteca de PDF de terceros compatible.

Configura los ajustes de la organización

Para agregar o actualizar los atributos de la organización, puedes usar una solicitud PUT, como la siguiente: ejemplo muestra:

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"
      }
    ]
  }
}

La siguiente tabla muestra los atributos a nivel de la organización que están disponibles para configurar una acuñación.

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

Núcleo fiscal (el valor predeterminado es nulo)
MINT_DEFAULT_PROD_TAX_CATEGORY

Categoría fiscal del producto predeterminada (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 fiscal (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 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

&quot;PREPAID&quot;/&quot;POSTPAID&quot;/&quot;BOTH&quot; (el valor predeterminado es "PREPAGADO")
MINT_IS_SEPARATE_INV_FOR_FEES

Indica si se debe generar una factura de tarifa independiente (el valor predeterminado es “false”).
MINT_ISSUE_NETTING_STMT

Indica si se debe emitir la declaración de compensación (el valor predeterminado es “false”).
MINT_NETTING_STMT_PER_CURRENCY

Indica si la declaración de compensación se debe generar por moneda (el valor predeterminado es "false")
MINT_HAS_SELF_BILLING

Indica si la organización tiene autofacturación (el valor predeterminado es “false”).
MINT_SELF_BILLING_FOR_ALL_DEV

Indica si la organización tiene autofacturación 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

Lo usa la IU de administración para mostrar el menú específico de monetización (el valor predeterminado es "false")
ui.config.isOperator

Lo usa la IU de administración para mostrar el proveedor como Operador en lugar de Organización (el valor predeterminado es "verdadero")

Para definir la configuración de la organización de la empresa 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ó a la tarifa de recuperación ante desastres.
  • El desarrollador superó el volumen de transacciones del plan de tarifas al que se suscribió.
  • Se alcanzó el saldo de la cuenta prepaga 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 siguientes: las mencionadas anteriormente. La política extiende la política Aumentar errores, y puedes personalizar el mensaje que se devuelven. Las condiciones aplicables se derivan de las variables de negocio.

Para obtener más información, consulta Aplicación de la límites de monetización en los proxies de API.