Como instalar serviços de monetização

Edge for Private Cloud v. 4.17.05

Os serviços de monetização são uma extensão do Apigee Edge. Por isso, eles não são executados de forma independente. de desenvolvimento de software. Ele é executado em qualquer configuração atual do Apigee Edge.

Requisitos de monetização

  • Se você estiver instalando a monetização em uma topologia de borda que usa vários servidores de gerenciamento nós, como uma instalação de 13 nós, instale 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, faça o seguinte: 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 mestres do Postgres. Para mais informações, consulte Configurar replicação mestre em espera para Postgres.

Visão geral da instalação

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

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

    Se você tiver vários nós do Management Server, como uma instalação de 13 nós, será preciso instalar os dois nós do Edge Management Server antes de instalar a Monetização.
  • Use o comando apigee-setup para atualizar o processador de mensagens da Apigee a fim de ativar os componentes do ambiente de execução do Serviços de monetização, por exemplo, política de registro de transações e aplicação de limites. Se você tiver vários processadores de mensagens, instale a monetização em todos eles.
  • Executar o processo de integração de monetização nas suas organizações de Edge.
  • Configure 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.

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. Editar conforme necessário para a configuração. Use a opção -f para setup.sh e incluir esse arquivo.

Observação: normalmente, você adiciona essas propriedades ao mesmo arquivo de configuração que usado para instalar o Edge, conforme mostrado em Instalar o Edge os componentes de 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
SMTPMAILFROM="My Company <myco@company.com>"
Observações:
  • Se o arquivo de configuração do Edge não tiver especificado as informações de SMTP, adicione-as. A monetização requer uma servidor SMTP.
  • Em uma única instalação de um data center, todos os nós do ZooKeeper são, por padrão, configurados como líderes. Quando você instala o Edge em vários data centers, alguns nós do ZooKeeper podem ser configurados como observadores. Verifique se a propriedade ZK_HOSTS acima especifica um nó líder em instalação de vários data centers.
  • Se você ativar a autenticação do Cassandra, poderá passar o nome de usuário e a senha do Cassandra usando as seguintes propriedades:
    CASS_USERNAME
    CASS_PASSWORD

Integrar 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 de borda que usa vários servidores de gerenciamento nós, como uma instalação de 13 nós, verifique se você instalou o servidor de gerenciamento nós antes de instalar a monetização.
  2. No nó do Servidor de gerenciamento, execute o script de configuração:
    &gt; /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    A opção "-p mo" especifica para integrar a monetização.

    O arquivo de configuração precisa ser acessível ou legível para a "apigee" usuário.
  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.

Se a configuração for bem-sucedida, um esquema RDBMS para os serviços de monetização é criado no PostgreSQL. Isso conclui a integração dos Serviços de monetização e dos respectivos com o Postgres Server.

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

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

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

    A opção "-p mo" especifica para integrar a monetização.

    O arquivo de configuração precisa ser acessível ou legível para a "apigee" usuário.
  2. 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 seus componentes associados com o Processadores.

Integração de monetização

Para criar uma nova organização com monetização ativada, primeiro crie a organização como que você faria com 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 da monetização em uma organização, você precisa:

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

Use a opção enable-monetization para executar todas essas tarefas. Esse script usa um arquivo de configuração que contém o propriedades a seguir:

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 pelos mesmos valores que usados ao instalar a Monetização.
  • Se você estiver ativando a monetização em uma configuração de vários data centers:
    • Você precisa repetir o processo de integração no servidor de gerenciamento em cada dado de eventos.
    • O arquivo de configuração deve listar apenas os nós Qpid no data center sendo configurada.

Para executar o script, siga as etapas a seguir:

  1. Invoque o script:
    &gt; /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 para a "apigee" usuário.

    Se você tiver vários servidores de gerenciamento, só precisará executar o script em um deles.

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

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

Configurar o desenvolvedor Portal de serviços

Para configurar o portal de serviços para desenvolvedores com suporte à monetização, consulte http://apigee.com/docs/monetization/content/configure-monetization-developer-portal.

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

Se você adicionar um servidor de gerenciamento a uma instalação de borda atual, será preciso adicionar Serviços de monetização para o novo servidor de gerenciamento e configurar todos os servidores de gerenciamento para que eles conseguem se comunicar.

Para adicionar um servidor de gerenciamento:

  1. Instale o novo Management Server.
  2. Instale a monetização no novo servidor de gerenciamento.
  3. No servidor de gerenciamento original, chame o seguinte:
    &gt; /opt/apigee/apigee-service/bin/apigee-service Edge-mint-management-server mint-configure-mgmt-cluster
  4. Reinicie o servidor de gerenciamento original:
    &gt; /opt/apigee/apigee-service/bin/apigee-service Edge-management-server reinicialização
  5. No novo Management Server, chame o seguinte:
    &gt; /opt/apigee/apigee-service/bin/apigee-service Edge-mint-management-server mint-configure-mgmt-cluster
  6. Reinicie o novo Management Server:
    &gt; /opt/apigee/apigee-service/bin/apigee-service Edge-management-server reinicialização

Configurações avançadas

Forneça documentos de faturamento como Arquivos PDF

A monetização exibe documentos de faturamento para os usuários finais no formato HTML. Para fornecer faturamento documentos como arquivos PDF, você pode integrar a monetização com um sistema de faturamento que fornece ou licenciar uma biblioteca de PDF de terceiros compatível.

Configurar organização Configurações

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 essas como 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 ISO de moeda (o padrão é nulo)

MINT_TAX_NEXUS

Domicílio fiscal (o padrão é nulo)

MINT_DEFAULT_PROD_TAX_CATEGORY

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

MINT_IS_GROUP_ORG

Organização do grupo de IS (o padrão é falso)

MINT_HAS_BROKER

Corrompeu (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

O número de registro da organização no Reino Unido fornece um número diferente do CPF/CNPJ (o padrão é nulo)

MINT_BILLING_CYCLE_TYPE

PRORATED, AGENDA_MONTH (o padrão é AGENDA_MONTH)

MINT_SUPPORTED_BILLING_TYPE

PREPAID/PÓS-PAGA/AMBOS (o padrão é PREPAID)

MINT_IS_SEPARATE_INV_FOR_FEES

Indica se uma fatura de tarifa separada precisa ser gerada (o padrão é "false")

MINT_ISSUE_NETTING_STMT

Indica se a declaração de compensação deve ser emitida (o padrão é "false")

MINT_NETTING_STMT_PER_CURRENCY

Indica se o extrato deve ser gerado por moeda (o padrão é Falso)

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 é 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 oferece suporte a ajustes de faturamento (o padrão é "false")

features.isMonetizationEnabled

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

ui.config.isOperator

Usado pela interface de gerenciamento para mostrar o provedor como operador em vez de 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 notificações e limites de serviços de monetização recursos, instrua seus desenvolvedores a anexar uma política de limites no fluxo de proxy após os política de validação de tokens de acesso.

A política de limites é uma política explícita projetada para bloquear uma chamada de API se determinado limite foi alcançado. A política verifica os limites da empresa e informa se algum limite excede o valor configurado. Essa é uma extensão da política de aumento de falhas, mas as condições são derivadas das variáveis de negócios.

Um modelo de interface está disponível na interface de gerenciamento para desenvolvedores de proxy. O desenvolvedor proxy deve anexar a política de moeda no fluxo de mensagens. Após a execução desta política, a falha aparecerá com a resposta de falha de acordo com a política. Se ContinueOnError for definido como verdadeiro, a falha não será gerado e flui as variáveis "mint.limitsViolated", "mint.isDeveloper suspended" e "mint.limitsPolicyError" as variáveis são definidas que pode ser usado para processamento adicional de exceções, se necessário.