Como instalar serviços de monetização

Edge para nuvem privada v. 4.16.09

Os serviços de monetização são uma extensão da Apigee Edge, portanto, não são executados como um processo independente. Ele é executado em qualquer configuração atual da Apigee Edge.

Requisitos de monetização

  • Se você estiver instalando a Monetização em uma topologia do Edge que usa vários nós do servidor de gerenciamento, como uma instalação de 13 nós, instale os dois nós do servidor de gerenciamento do Edge antes de instalar a Monetização.
  • Para instalar a Monetização no Edge em que a instalação do Edge tem vários nós do Postgres, os nós do Postgres precisam ser configurados no modo mestre/em espera. Não é possível instalar a Monetização no Edge se você tiver vários nós mestre do Postgres. Para mais informações, consulte Configurar a replicação mestre-em espera para o Postgres.

Visão geral da instalação

As etapas a seguir ilustram como adicionar serviços de monetização em uma instalação atual do Apigee Edge:

  • Use o utilitário apigee-setup para atualizar o nó do servidor de gerenciamento da Apigee e ativar os serviços de monetização, como gerenciamento de catálogo, configuração de limites e notificações, faturamento e relatórios.

    Se você tiver vários nós do servidor de gerenciamento, como uma instalação de 13 nós, será necessário instalar os dois nós do servidor de gerenciamento do Edge antes de instalar a Monetização.
  • Use o utilitário apigee-setup para atualizar o processador de mensagens da Apigee e ativar os componentes de ambiente de execução dos serviços de monetização, por exemplo, a política de registro de transações e a aplicação de limites. Se você tiver vários processadores de mensagens, instale a Monetização em todos eles.
  • Realize o processo de integração da Monetização para suas organizações do Edge.
  • Configurar o portal de serviços para desenvolvedores para oferecer suporte à monetização. Para mais informações, consulte http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

Como criar um arquivo de configuração silenciosa para Monetização

Veja abaixo um exemplo de arquivo de configuração silenciosa para uma instalação da Monetização. Edite esse arquivo conforme necessário para sua configuração. Use a opção -f para setup.sh para incluir esse arquivo.

Observação: normalmente, você adiciona essas propriedades ao mesmo arquivo de configuração usado para instalar o Edge, conforme mostrado em Instalar componentes do Edge em um nó.

# 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
Observações:
  • Se o arquivo de configuração do Edge não especificou as informações de SMTP, adicione-as. A Monetização requer um servidor SMTP.
  • Em uma instalação de data center único, todos os nós do ZooKeeper são configurados por padrão como líderes. Ao instalar o Edge em vários data centers, alguns nós do ZooKeeper serão configurados como observadores. Verifique se a propriedade ZK_HOSTS acima especifica um nó líder em uma instalação de vários data centers.
  • Se você ativar a autenticação do Cassandra, poderá transmitir o nome de usuário e a senha do Cassandra usando as seguintes propriedades:
    CASS_USERNAME
    CASS_PASSWORD

Integrar os serviços de monetização com todos os servidores de gerenciamento

Use o procedimento a seguir para integrar a monetização nos nós do servidor de gerenciamento.

  1. Se você estiver instalando a Monetização em uma topologia do Edge que usa vários nós do servidor de gerenciamento, como uma instalação de 13 nós, verifique se você instalou os dois nós do servidor de gerenciamento antes de instalar a Monetização.
  2. No nó do servidor de gerenciamento, execute o script de configuração:
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    A opção "-p mo" especifica a integração da Monetização.

    O arquivo de configuração precisa ser acessível ou legível pelo usuário "apigee".
  3. Se você estiver instalando a Monetização em vários nós do servidor de gerenciamento, repita a etapa 2 no segundo nó do servidor de gerenciamento.

Após a configuração, um esquema RDBMS para os Serviços de Monetização é criado no banco de dados PostgreSQL. Isso conclui a integração dos serviços de monetização e os componentes associados ao servidor Postgres.

Integrar os serviços de monetização com todos os processadores de mensagens

Use o procedimento a seguir para integrar a monetização em todos os nós do processador de mensagens.

  1. No primeiro nó do processador de mensagens, no prompt de comando, execute o script de configuração:
    > /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    A opção "-p mo" especifica a integração da Monetização.

    O arquivo de configuração precisa ser acessível ou legível pelo usuário "apigee".
  2. Repita esse procedimento em todos os nós do processador de mensagens.

Após a configuração, o processador de mensagens é atualizado com os serviços de monetização. Isso conclui a integração dos serviços de monetização e os componentes associados aos processadores de mensagens.

Integração de monetização

Para criar uma nova organização com a monetização ativada, primeiro crie a organização como faria para qualquer nova organização. Para mais informações, consulte Integrar uma organização.

Integração adicional para ativar a monetização em uma organização

Para concluir a integração de monetização de uma organização, você precisa:

  1. Crie o grupo de monetização: mxgroup.
  2. Adicione o Qpid ao grupo.
  3. Ative a monetização para a organização.
  4. Ative as configurações de notificação para a organização.
  5. Repita esse processo para todas as organizações em que você quer ativar a Monetização.

Use o comando enable-monetization para realizar todas essas tarefas. Esse script usa um arquivo de configuração que contém as seguintes propriedades:

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.

Observações:

  • Defina CASS_HOSTS e REGION com os mesmos valores usados ao instalar a Monetização.
  • Se você estiver ativando a Monetização em uma configuração de vários data centers:
    • É necessário repetir o processo de integração no servidor de gerenciamento em cada data center.
    • O arquivo de configuração deve listar apenas os nós do Qpid no data center que está sendo configurado.

Para executar o script, siga as etapas a seguir:

  1. Invoque o script:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile

    O arquivo de configuração precisa ser acessível ou legível pelo usuário "apigee".

    Se você tiver vários servidores de gerenciamento, execute esse script em apenas um deles.

    Esse script replica a organização, os produtos, os desenvolvedores e os aplicativos do banco de dados do Cassandra para o banco de dados do PostgreSQL de monetização. Após a instalação bem-sucedida dos serviços de monetização, os dados são sincronizados automaticamente.
  2. Repita esse procedimento para cada organização em que você quer ativar a Monetização.
  3. Se você estiver em um ambiente com vários data centers, repita esse processo no servidor de gerenciamento no outro data center. Verifique se o arquivo de configuração lista apenas os nós do Qpid no data center que está sendo configurado.

Na próxima vez que você fizer login na IU do Edge, verá a entrada "Monetização" no menu de nível superior da organização:

Configurar o portal de serviços para desenvolvedores

Para configurar o portal de serviços para desenvolvedores para que ele seja compatível com a monetização, consulte http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

Como adicionar um nó do servidor de gerenciamento a uma instalação de monetização

Se você adicionar um servidor de gerenciamento a uma instalação atual do Edge, adicione os serviços de monetização ao novo servidor de gerenciamento e configure todos os servidores de gerenciamento para que eles possam se comunicar.

Para adicionar um servidor de gerenciamento:

  1. Instale o novo servidor de gerenciamento.
  2. Instale a Monetização no novo servidor de gerenciamento.
  3. No servidor de gerenciamento original, chame o seguinte:
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. Reinicie o servidor de gerenciamento original:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. No novo servidor de gerenciamento, chame o seguinte:
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. Reinicie o novo servidor de gerenciamento:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

Configurações avançadas

Fornecer documentos de faturamento como arquivos PDF

A Monetização exibe documentos de faturamento para os usuários finais no formato HTML. Para fornecer documentos de faturamento como arquivos PDF, é possível integrar a Monetização a um sistema de faturamento que forneça geração de PDF ou licenciar uma biblioteca de PDF de terceiros compatível.

Definir as configurações da organização

Configurações de back-end: a tabela a seguir lista os atributos no nível da organização disponíveis para configurar uma organização do Mint. É possível usar uma chamada PUT para adicionar/atualizar esses atributos, conforme mostrado abaixo:

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

Por exemplo, a saída do comando CURL acima será semelhante a esta:

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

Atributos

Descrição

MINT_TAX_MODEL

Os valores aceitos são DISCLOSED,

UNDISCLOSED, HYBRID (o padrão é nulo)

MINT_CURRENCY

Código de moeda ISO (o padrão é nulo)

MINT_TAX_NEXUS

Nexo fiscal (o padrão é nulo)

MINT_DEFAULT_PROD_TAX_CATEGORY

Categoria fiscal padrão do produto (o padrão é nulo)

MINT_IS_GROUP_ORG

É uma organização de grupo (o padrão é falso)

MINT_HAS_BROKER

Tem quebrado (o padrão é falso)

MINT_TIMEZONE

Fuso horário (o padrão é nulo)

MINT_TAX_ENGINE_EXTERNAL_ID

ID do mecanismo de tributação (o padrão é nulo)

MINT_COUNTRY

País da organização (o padrão é nulo)

MINT_REG_NO

Número de registro da organização, o Reino Unido fornece um número diferente do ID fiscal (o padrão é nulo)

MINT_BILLING_CYCLE_TYPE

PRORATED, CALENDAR_MONTH (o padrão é CALENDAR_MONTH)

MINT_SUPPORTED_BILLING_TYPE

PREPAID/POSTPAID/BOTH (o padrão é PREPAID)

MINT_IS_SEPARATE_INV_FOR_FEES

Indica se uma fatura de taxa separada precisa ser gerada (o padrão é falso)

MINT_ISSUE_NETTING_STMT

Indica se o extrato de compensação deve ser emitido (o padrão é falso)

MINT_NETTING_STMT_PER_CURRENCY

Indica se o extrato de compensação deve ser gerado por moeda (o padrão é falso)

MINT_HAS_SELF_BILLING

Indica se a organização tem autofaturamento (o padrão é falso)

MINT_SELF_BILLING_FOR_ALL_DEV

Indica se a organização tem faturamento automático para todos os desenvolvedores(o padrão é falso)

MINT_HAS_SEPARATE_INV_FOR_PROD

Indica se a organização tem uma fatura separada por produto (o padrão é falso)

MINT_HAS_BILLING_ADJUSTMENT

Indica se a organização aceita ajustes de serviço (o padrão é "false").

features.isMonetizationEnabled

Usado pela interface de gerenciamento para exibir o menu específico de monetização (o padrão é falso)

ui.config.isOperator

Usado pela interface de gerenciamento para exibir o provedor como operador ou organização.

(o padrão é verdadeiro)

Para definir as configurações da organização empresarial usando a IU de gerenciamento, consulte http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services.

Observação: se você estiver usando os recursos de limites e notificações dos serviços de monetização, instrua os desenvolvedores a anexar uma política de limite no fluxo de proxy após a política de validação do token de acesso.

A política de limite é uma política explícita projetada para bloquear uma chamada de API se um determinado limite tiver sido atingido. A política verifica os limites de negócios e gera uma falha se houver limites que excedam o valor configurado. Essa é uma extensão da política de geração de falhas, mas as condições são derivadas de variáveis de negócios.

Um modelo de interface está disponível na interface de gerenciamento para desenvolvedores de proxy. O desenvolvedor de proxy precisa anexar a política de geração no fluxo de mensagens. Após a execução dessa política, a falha será gerada com a resposta de falha de acordo com a política. Se ContinueOnError for definido como verdadeiro, a falha não será gerada e as variáveis de fluxo "mint.limitsViolated", "mint.isDeveloperSuspended" e "mint.limitsPolicyError" serão definidas, o que pode ser usado para um tratamento de exceções adicional, se necessário.