Installazione di servizi di monetizzazione

Monetization Services è un'estensione di Apigee Edge, pertanto non viene eseguito come processo autonomo. Funziona in qualsiasi configurazione di Apigee Edge esistente, ad eccezione della configurazione All-In-One (AIO). Non puoi installare Monetization Services in una configurazione AIO.

Requisiti di monetizzazione

  • Se stai installando la monetizzazione su una topologia Edge che utilizza più nodi del server di gestione, ad esempio un'installazione di 13 nodi, devi installare entrambi i nodi del server di gestione Edge prima di installare la monetizzazione.
  • Per installare la monetizzazione su Edge quando l'installazione di Edge ha più nodi Postgres, i nodi Postgres devono essere configurati in modalità Master/Standby. Non puoi installare Monetizzazione su Edge se hai più nodi master Postgres. Per saperne di più, consulta Configurare la replica master-standby per Postgres.
  • La monetizzazione non è disponibile con la configurazione All-In-One (AIO).

Panoramica dell'installazione

I passaggi riportati di seguito illustrano come aggiungere i servizi di monetizzazione a un'installazione di Apigee Edge esistente:

  • Utilizza l'utilità apigee-setup per aggiornare il nodo Apigee Management Server in modo da attivare i servizi di monetizzazione, ad esempio la gestione del catalogo, la configurazione di limiti e notifiche, la fatturazione e la generazione di report.

    Se hai più nodi di Management Server, ad esempio un'installazione con 13 nodi, devi installare entrambi i nodi di Edge Management Server prima di installare Monetization.

  • Utilizza l'utilità apigee-setup per aggiornare il processore di messaggi Apigee in modo da abilitare i componenti runtime dei servizi di monetizzazione, ad esempio il criterio di registrazione delle transazioni e limitare l'applicazione. Se hai più processori di messaggi, installa la monetizzazione su tutti.
  • Eseguire il processo di onboarding della monetizzazione per le organizzazioni perimetrali.
  • Configura il portale Apigee Developer Services (o semplicemente il portale) per supportare la monetizzazione. Per ulteriori informazioni, consulta Configurare la monetizzazione nello Developer Portal.

Creazione di un file di configurazione silenzioso per la monetizzazione

Di seguito è riportato un esempio di file di configurazione silenzioso per un'installazione di Monetizzazione. Modifica questo file in base alle esigenze della tua configurazione. Utilizza l'opzione -f in setup.sh per includere questo file.

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

Note:

  • Se il file di configurazione di Edge non ha specificato le informazioni SMTP, aggiungile. La monetizzazione richiede un server SMTP.
  • In un'installazione in un singolo data center, i numeri dispari di nodi ZooKeeper devono essere configurati come voters. Se il numero di nodi ZooKeeper è pari, alcuni nodi verranno configurati come observers. Quando installi Edge in un numero pari di data center, alcuni nodi ZooKeeper devono essere configurati come observers per rendere dispari il numero di nodi degli elettori. Durante l'elezione del leader di ZooKeeper, un nodo votante verrà eletto come leader. Assicurati che la proprietà ZK_HOSTS sopra riportata specifichi un nodo leader in un'installazione con più data center.
  • Se attivi l'autenticazione Cassandra, puoi trasmettere il nome utente e la password Cassandra utilizzando le seguenti proprietà: 
    CASS_USERNAME
CASS_PASSWORD

Integrare i servizi di monetizzazione con tutti i server di gestione

Utilizza la procedura seguente per integrare la monetizzazione nei nodi del server di gestione.

  1. Se stai installando Monetizzazione su una topologia Edge che utilizza più nodi del server di gestione, ad esempio un'installazione di 13 nodi, assicurati di aver installato entrambi i nodi del server di gestione prima di installare Monetizzazione.
  2. Sul nodo del server di gestione, esegui lo script di configurazione:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    L'opzione -p mo specifica di integrare la monetizzazione.

    Il file di configurazione deve essere accessibile o leggibile dall'utente "apigee".

  3. Se stai installando la monetizzazione su più nodi del server di gestione, ripeti il passaggio 2 sul secondo nodo del server di gestione.

Una volta completata la configurazione, nel database PostgreSQL viene creato uno schema RDBMS per i servizi di monetizzazione. In questo modo, viene completata l'integrazione di Monetization Services e dei relativi componenti associati con Postgres Server.

Integra i servizi di monetizzazione con tutti i processori di messaggi

Utilizza la procedura seguente per integrare la monetizzazione su tutti i nodi del Message Processor.

  1. Sul primo nodo del processore di messaggi, esegui lo script di configurazione al prompt dei comandi: 
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    L'opzione -p mo specifica di integrare la monetizzazione.

    Il file di configurazione deve essere accessibile o leggibile dall'utente "apigee".

  2. Ripeti questa procedura su tutti i nodi di elaborazione dei messaggi.

Al termine della configurazione, il Message Processor viene aggiornato con Monetization Services. L'integrazione dei Servizi di monetizzazione e dei relativi componenti associati con i Processori di messaggi è completata.

Onboarding della monetizzazione

Per creare una nuova organizzazione e attivare la monetizzazione:

  1. Crea l'organizzazione come faresti con qualsiasi altra nuova organizzazione. Per ulteriori informazioni, consulta Eseguire l'onboarding di un'organizzazione.
  2. Utilizza l'API di provisioning della monetizzazione come descritto in Attivare la monetizzazione per un'organizzazione. Per farlo, devi disporre dei privilegi di amministratore di sistema.

Al successivo accesso alla UI di Edge, vedrai la voce Monetizzazione nel menu di primo livello relativo all'organizzazione:

Per configurare il portale in modo che supporti la monetizzazione, consulta Configurare la monetizzazione nel Portale per gli sviluppatori.

Aggiunta di un nodo di un server di gestione a un'installazione della monetizzazione

Se aggiungi un server di gestione a un'installazione Edge esistente, devi assicurarti di aggiungere i servizi di monetizzazione al nuovo server di gestione e di configurare tutti i server di gestione in modo che possano comunicare.

Per aggiungere un server di gestione:

  1. Installa il nuovo Management Server.
  2. Installa la monetizzazione sul nuovo server di gestione.
  3. Sul server di gestione originale, chiama quanto segue: 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. Riavvia il server di gestione originale: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. Sul nuovo server di gestione, chiama quanto segue: 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. Riavvia il nuovo server di gestione: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

Configurazione aggiuntiva

Fornisci i documenti di fatturazione come file PDF

La monetizzazione mostra i documenti di fatturazione agli utenti finali in formato HTML. Per fornire i documenti di fatturazione come file PDF, puoi integrare la monetizzazione con un sistema di fatturazione che fornisca la generazione di PDF o acquistare una licenza per una libreria PDF di terze parti supportata.

Configura le impostazioni dell'organizzazione

Per aggiungere/aggiornare gli attributi dell'organizzazione, puoi utilizzare una richiesta PUT, come illustrato nell'esempio seguente:

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

La monetizzazione risponde con le impostazioni dell'organizzazione. Ad esempio:

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

La tabella riportata di seguito elenca gli attributi a livello di organizzazione disponibili per configurare un'organizzazione di zecca.

Attributi Descrizione
MINT_TAX_MODEL

I valori accettati sono "DISCLOSED", "UNDISCLOSED", "HYBRID" (il valore predefinito è null)
MINT_CURRENCY

Codice valuta ISO (valore predefinito nullo)
MINT_TAX_NEXUS

Nexus fiscale (valore predefinito nullo)
MINT_DEFAULT_PROD_TAX_CATEGORY

Categoria fiscale predefinita sui prodotti (il valore predefinito è null)
MINT_IS_GROUP_ORG

Organizzazione del gruppo IS (il valore predefinito è "false")
MINT_HAS_BROKER

Non funzionante (il valore predefinito è false)
MINT_TIMEZONE

Fuso orario (il valore predefinito è null)
MINT_TAX_ENGINE_EXTERNAL_ID

ID motore fiscale (il valore predefinito è null)
MINT_COUNTRY

Paese dell'organizzazione (il valore predefinito è null)
MINT_REG_NO

Il numero di registrazione dell'organizzazione nel Regno Unito è diverso dall'ID fiscale (il valore predefinito è null)
MINT_BILLING_CYCLE_TYPE

"PRORATED", "CALENDAR_MONTH" (il valore predefinito è "CALENDAR_MONTH")
MINT_SUPPORTED_BILLING_TYPE

"PREPAID"/"POSTPAID"/"BOTH" (il valore predefinito è "PREPAID")
MINT_IS_SEPARATE_INV_FOR_FEES

Indica se deve essere generata una fattura separata per le commissioni (il valore predefinito è "false")
MINT_ISSUE_NETTING_STMT

Indica se deve essere emesso l'estratto conto di compensazione (il valore predefinito è "false")
MINT_NETTING_STMT_PER_CURRENCY

Indica se l'estratto conto di compensazione deve essere generato per valuta (il valore predefinito è "false").
MINT_HAS_SELF_BILLING

Indica se l'organizzazione ha l'autofatturazione (il valore predefinito è "false")
MINT_SELF_BILLING_FOR_ALL_DEV

Indica se l'organizzazione ha attivato la fatturazione diretta per tutti gli sviluppatori (il valore predefinito è "false").
MINT_HAS_SEPARATE_INV_FOR_PROD

Indica se l'organizzazione ha una fattura separata per prodotto (il valore predefinito è "false").
MINT_HAS_BILLING_ADJUSTMENT

Indica se l'organizzazione supporta gli aggiustamenti di fatturazione (il valore predefinito è "false")
features.isMonetizationEnabled

Utilizzato dall'interfaccia utente di gestione per visualizzare il menu specifico per la monetizzazione (il valore predefinito è "false").
ui.config.isOperator

Utilizzato dall'interfaccia utente di gestione per visualizzare il fornitore come operatore rispetto all'organizzazione (il valore predefinito è "true").

Per configurare le impostazioni dell'organizzazione aziendale utilizzando l'interfaccia utente di gestione, consulta Accedere alla monetizzazione in Edge.

Limiti di monetizzazione

Per applicare i limiti di monetizzazione, collega la norma relativa al controllo dei limiti di monetizzazione ai proxy API. Nello specifico, il criterio viene attivato nelle seguenti condizioni:

  • Lo sviluppatore che accede all'API monetizzata non è registrato o non ha sottoscritto il piano tariffario.
  • Lo sviluppatore ha superato il volume di transazioni per il piano tariffario a cui è stata effettuata l'iscrizione.
  • È stato raggiunto il saldo dell'account prepagato o il limite di credito postpaid dello sviluppatore.

Il criterio di controllo dei limiti di monetizzazione genera errori e blocca le chiamate API in situazioni come quelle elencate sopra. Il criterio estende il criterio di generazione di errori e puoi personalizzare il messaggio restituito. Le condizioni applicabili derivano dalle variabili aziendali.

Per ulteriori informazioni, consulta Applicare i limiti di monetizzazione ai proxy API.