Esta página foi traduzida pela API Cloud Translation.

Como instalar serviços de monetização

Os serviços de monetização são uma extensão do Apigee Edge, portanto, não são executados como um processo autônomo. Ele é executado em qualquer configuração atual do Apigee Edge, exceto a configuração All-in-One (AIO). Não é possível instalar os serviços de monetização em uma configuração AIO.

Requisitos de monetização

Se você estiver instalando a monetização em uma topologia de borda que usa 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 de borda 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, é necessário configurá-los no modo mestre/em espera. Não é possível instalar a Monetização no Edge se você tiver vários nós mestres do Postgres. Para mais informações, consulte Configurar a replicação " Master-Standby" do Postgres.
A monetização não está disponível com a configuração All in One (AIO).

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 para ativar os serviços de monetização, por exemplo, 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 antes de instalar a monetização.
Use o utilitário apigee-setup para atualizar o Apigee Message Processor e ativar os componentes do 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.
Execute o processo de integração de monetização para suas organizações de Edge.
Configure o portal de serviços para desenvolvedores da Apigee (ou simplesmente o portal) para oferecer suporte à monetização. Para mais informações, consulte Configurar a monetização no Portal do desenvolvedor.

Como criar um arquivo de configuração silencioso para monetização

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

# 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>"

Observações:

Se o arquivo de configuração do Edge não tiver especificado as informações SMTP, adicione-o. A monetização requer um servidor SMTP.
Em uma única instalação de data center, os números ímpares de nós do ZooKeeper precisam ser configurados como voters. Se vários nós do ZooKeeper forem pares, alguns deles serão configurados como observers. Ao instalar o Edge em um número par de data centers, alguns nós do ZooKeeper precisam ser configurados como observers para tornar o número de nós de eleitor ímpar. Durante a eleição de líder do ZooKeeper, um nó de eleitor será eleito como leader. 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 a todos os servidores de gerenciamento

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

Se você estiver instalando a monetização em uma topologia de borda que usa vários nós do servidor de gerenciamento, como uma instalação de 13 nós, verifique se você instalou ambos os nós antes de instalar a monetização.
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 para o usuário "apigee".
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.

Se a configuração for bem-sucedida, um esquema RDBMS para serviços de monetização será criado no banco de dados do PostgreSQL. Isso conclui a integração dos Serviços de Monetização e dos componentes associados ao Postgres Server.

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

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

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 para o usuário "apigee".
Repita esse procedimento em todos os nós do processador de mensagens.

Se a configuração for bem-sucedida, o Processador de mensagens será atualizado com os Serviços de monetização. Isso conclui a integração dos Serviços de Monetização e dos componentes associados com os Processadores de mensagens.

Integração da monetização

Para criar uma nova organização e ativar a monetização:

Crie a organização como você faria com qualquer organização nova. Para mais informações, consulte Integrar uma organização.
Use a API de aprovisionamento de monetização, conforme descrito em Ativar monetização para uma organização. Para isso, é preciso ter privilégios de administrador do sistema.

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

Para configurar o portal e oferecer suporte à monetização, consulte Configurar a monetização no portal do desenvolvedor.

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 de borda existente, não se esqueça de adicionar serviços de monetização ao novo servidor de gerenciamento e configurar todos os servidores de gerenciamento para que eles possam se comunicar.

Para adicionar um servidor de gerenciamento:

Instale o novo servidor de gerenciamento.
Instale a monetização no novo servidor de gerenciamento.

No servidor de gerenciamento original, chame o seguinte:

/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster

Reinicie o servidor de gerenciamento original:

/opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

No novo servidor de gerenciamento, chame o seguinte:

/opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster

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 em formato HTML. Para fornecer documentos de faturamento como arquivos PDF, é possível integrar a Monetização a um sistema de faturamento que fornece geração de PDF ou licenciar uma biblioteca de PDF de terceiros compatível.

Definir as configurações da organização

Para adicionar/atualizar atributos da organização, use uma solicitação PUT, como mostra o exemplo a seguir:

curl -u SYS_ADMIN_EMAIL:SYS_ADMIN_PASSWORD \
  -v http://ms_IP:8080/v1/organizations/orgId -d 'org object with attributes' -X PUT

A monetização responde com as configurações da organização. Por exemplo:

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

A tabela a seguir lista os atributos no nível da organização disponíveis para configurar uma organização da casa da moeda.

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`	Imposto de presença física (o padrão é nulo)
`MINT_DEFAULT_PROD_TAX_CATEGORY`	Categoria fiscal do produto padrão (o padrão é nulo)
`MINT_IS_GROUP_ORG`	IS group group (o padrão é "false")
`MINT_HAS_BROKER`	Quebrado (o padrão é falso)
`MINT_TIMEZONE`	Fuso horário (o padrão é nulo)
`MINT_TAX_ENGINE_EXTERNAL_ID`	ID do mecanismo fiscal (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 CPF/CNPJ (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 deve ser gerada (o padrão é "false")
`MINT_ISSUE_NETTING_STMT`	Indica se a instrução de rede deve ser emitida (o padrão é "false")
`MINT_NETTING_STMT_PER_CURRENCY`	Indica se a instrução de rede deve ser gerada por moeda (o padrão é "false")
`MINT_HAS_SELF_BILLING`	Indica se a organização tem faturamento próprio (o padrão é "false")
`MINT_SELF_BILLING_FOR_ALL_DEV`	Indica se a organização tem faturamento próprio para todos os desenvolvedores (o padrão é "false")
`MINT_HAS_SEPARATE_INV_FOR_PROD`	Indica se a organização tem faturas separadas por produto (o padrão é "false")
`MINT_HAS_BILLING_ADJUSTMENT`	Indica se a organização é compatível com ajustes de faturamento (o padrão é "false")
`features.isMonetizationEnabled`	Usado pela IU de gerenciamento para exibir o menu específico de monetização (o padrão é "false")
`ui.config.isOperator`	Usado pela IU de gerenciamento para exibir o provedor como a organização do verso dos versos (o padrão é "verdadeiro")

Para configurar a organização por meio da IU de gerenciamento, consulte Acessar a monetização no Edge.

Limites de monetização

Para aplicar limites de monetização, anexe a política de verificação de limites de monetização aos proxies de API. Especificamente, a política é acionada nas seguintes condições:

O desenvolvedor que acessa a API monetizada não está registrado ou não se inscreveu no plano de tarifas.
O desenvolvedor excedeu o volume de transações do plano de taxa da assinatura.
O limite da conta pré-paga do desenvolvedor ou o limite de crédito pós-pago foi atingido.

A política de verificação de limites de monetização gera falhas e bloqueia chamadas de API em situações como as listadas acima. A política estende a política Raise Fault, e você pode personalizar a mensagem retornada. As condições aplicáveis são derivadas de variáveis de negócios.

Para mais informações, consulte Aplicar limites de monetização a proxies de API.