Installazione di servizi di monetizzazione

Monetization Services è un'estensione di Apigee Edge, quindi non viene eseguito come processo autonomo. Viene eseguito all'interno di qualsiasi configurazione Apigee Edge esistente, ad eccezione della configurazione All-in-One (AIO). Non puoi installare Servizi di monetizzazione su una configurazione AIO.

Requisiti per la monetizzazione

  • Se stai installando la monetizzazione su una topologia perimetrale che utilizza più nodi del server di gestione, ad esempio un'installazione a 13 nodi, devi installare entrambi i nodi dell'edge Management Server prima di installare la monetizzazione.
  • Per installare la monetizzazione su Edge quando l'installazione a livello perimetrale 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-in standby per Postgres.
  • La monetizzazione non è disponibile con la configurazione All-in-One (AIO).

Panoramica dell'installazione

I passaggi seguenti illustrano come aggiungere servizi di monetizzazione su un'installazione Apigee Edge esistente:

  • Utilizza l'utilità apigee-setup per aggiornare il nodo del server di gestione Apigee per abilitare i servizi di monetizzazione, ad esempio gestione del catalogo, configurazione di limiti e notifiche, fatturazione e report.

    Se disponi di più nodi del server di gestione, ad esempio un'installazione a 13 nodi, devi installare entrambi i nodi di Edge Management Server prima di installare la monetizzazione.

  • Utilizza l'utilità apigee-setup per aggiornare il processore di messaggi Apigee per abilitare i componenti di runtime dei Servizi di monetizzazione, ad esempio le norme di registrazione delle transazioni e l'applicazione dei limiti. Se disponi di più Processori di messaggi, installa la monetizzazione su ciascuno di essi.
  • Esegui il processo di onboarding per la monetizzazione per le tue organizzazioni Edge.
  • Configura il portale Servizi per gli sviluppatori Apigee (o semplicemente il portale) per supportare la monetizzazione. Per maggiori informazioni, consulta Configurare la monetizzazione nel Portale per gli sviluppatori.

Creazione di un file di configurazione invisibile per la monetizzazione

Di seguito è riportato un esempio di file di configurazione invisibile all'utente per un'installazione relativa alla monetizzazione. Modifica questo file in base alle esigenze della tua configurazione. Utilizza l'opzione -f per 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 Edge non specifica le informazioni SMTP, aggiungilo. La monetizzazione richiede un server SMTP.
  • In una singola installazione di data center, i numeri dispari di nodi ZooKeeper devono essere configurati come voters. Se un numero di nodi ZooKeeper è pari, alcuni nodi verranno configurati come observers. Quando installi Edge su un numero pari di data center, alcuni nodi ZooKeeper devono essere configurati come observers per rendere dispari il numero di nodi elettori. Durante le elezioni del leader ZooKeeper, verrà eletto un nodo elettori come leader. Assicurati che la proprietà ZK_HOSTS riportata sopra specifichi un nodo leader in un'installazione in più data center.
  • Se attivi l'autenticazione Cassandra, puoi passare il nome utente e la password Cassandra utilizzando le seguenti proprietà:
    CASS_USERNAME
    CASS_PASSWORD

Integra i servizi di monetizzazione con tutti i server di gestione

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

  1. Se stai installando la monetizzazione su una topologia perimetrale che utilizza più nodi del server di gestione, ad esempio un'installazione a 13 nodi, assicurati di aver installato entrambi i nodi del server di gestione prima di installare la 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 consente di specificare l'integrazione della 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 Monetization Services. Questa operazione completa l'integrazione dei Servizi di monetizzazione e dei relativi componenti associati con il server Postgres.

Integra i Servizi di monetizzazione con tutti i processori di messaggi

Utilizza la procedura seguente per integrare la monetizzazione su tutti i nodi dell'elaborazione dei messaggi.

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

    L'opzione -p mo consente di specificare l'integrazione della monetizzazione.

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

  2. Ripeti questa procedura su tutti i nodi del processore di messaggi.

Una volta completata la configurazione, il Responsabile del trattamento dei messaggi viene aggiornato con i Servizi di monetizzazione. Questa completa l'integrazione dei Servizi di monetizzazione e dei relativi componenti associati con i Responsabili dei messaggi.

Onboarding di monetizzazione

Per creare una nuova organizzazione e attivare la monetizzazione:

  1. Crea l'organizzazione come faresti con qualsiasi nuova organizzazione. Per maggiori 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. A tale scopo, devi disporre dei privilegi di amministratore di sistema.

La volta successiva che eseguirai l'accesso alla UI di Edge, vedrai la voce Monetizzazione nel menu di primo livello dell'organizzazione:

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

Aggiungere un nodo del server di gestione a un'installazione di 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 configurare tutti i server di gestione in modo che possano comunicare.

Per aggiungere un server di gestione:

  1. Installa il nuovo server di gestione.
  2. Installa Monetizzazione sul nuovo server di gestione.
  3. Sul server di gestione originale, chiama:
    /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:
    /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 agli utenti finali i documenti di fatturazione in formato HTML. Per fornire i documenti di fatturazione come file PDF, puoi integrare la monetizzazione con un sistema di fatturazione che fornisce la generazione di PDF o la licenza di 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 utilizza 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 seguente tabella elenca gli attributi a livello di organizzazione disponibili per configurare un'organizzazione mint.

Attributi Descrizione
MINT_TAX_MODEL

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

MINT_CURRENCY

Codice valuta ISO (il valore predefinito è null)

MINT_TAX_NEXUS

Necessità di imposte (valore predefinito: null)

MINT_DEFAULT_PROD_TAX_CATEGORY

Categoria fiscale del prodotto predefinita (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 imposte (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, indica un numero 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 tariffa separata (il valore predefinito è "false")

MINT_ISSUE_NETTING_STMT

Indica se deve essere emessa una dichiarazione di compensazione (il valore predefinito è "false")

MINT_NETTING_STMT_PER_CURRENCY

Indica se è necessario generare un'istruzione di compensazione in base alla valuta (il valore predefinito è "false")

MINT_HAS_SELF_BILLING

Indica se l'organizzazione dispone della fatturazione autonoma (il valore predefinito è "false")

MINT_SELF_BILLING_FOR_ALL_DEV

Indica se l'organizzazione dispone della fatturazione autonoma 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 della monetizzazione (il valore predefinito è "false")

ui.config.isOperator

Utilizzato dall'interfaccia utente di gestione per visualizzare il provider come Operatore anziché 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 le norme sul controllo dei limiti di monetizzazione ai proxy API. In particolare, il criterio viene attivato alle seguenti condizioni:

  • Lo sviluppatore che accede all'API monetizzata non è registrato o non ha sottoscritto un abbonamento al piano tariffario.
  • Lo sviluppatore ha superato il volume di transazioni per il piano tariffario sottoscritto.
  • È stato raggiunto il saldo prepagato dell'account o il massimale di credito post-pagato dello sviluppatore.

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

Per maggiori informazioni, consulta la pagina sull'applicazione dei limiti di monetizzazione sui proxy API.