Para Kazanma Hizmetlerini Yükleme

Monetization Services, Apigee Edge'in bir uzantısı olduğundan bağımsız bir süreç olarak çalışmaz. Hepsi bir arada (AIO) yapılandırması hariç, mevcut tüm Apigee Edge kurulumlarında çalışır. AIO yapılandırmasına Para Kazanma Hizmetleri yükleyemezsiniz.

Para kazanma koşulları

  • 13 düğümlü yükleme gibi birden fazla Yönetim Sunucusu düğümü kullanan bir Edge topolojisine Para Kazanma'yı yüklüyorsanız Monetization'ı yüklemeden önce her iki Uç Yönetim Sunucusu düğümünü de yüklemeniz gerekir.
  • Uç yüklemenin birden fazla Postgres düğümüne sahip olduğu Uçta Para Kazanma özelliğini yüklemek için Postgres düğümlerinin Ana/Bekleme modunda yapılandırılması gerekir. Birden fazla Postgres ana düğümünüz varsa Edge'de Para Kazanma'yı yükleyemezsiniz. Daha fazla bilgi için Postgres için Master-Standby Çoğaltma'yı kurma bölümüne bakın.
  • Hepsi Bir Arada (AIO) yapılandırmasıyla para kazanma özelliği kullanılamaz.

Yüklemeye genel bakış

Aşağıdaki adımlarda, mevcut Apigee Edge kurulumuna Para Kazanma Hizmetleri'nin nasıl ekleneceği gösterilmektedir:

  • Para Kazanma Hizmetleri'ni (ör. katalog yönetimi, sınırlar ve bildirim yapılandırma, faturalandırma ve raporlama) etkinleştirmek amacıyla Apigee Yönetim Sunucusu düğümünü güncellemek için apigee-setup yardımcı programını kullanın.

    13 düğümlü yükleme gibi birden fazla Yönetim Sunucusu düğümünüz varsa Monetization'ı yüklemeden önce her iki Uç Yönetim Sunucusu düğümünü de yüklemeniz gerekir.

  • Para Kazanma Hizmetleri'nin işlem kaydetme politikası ve uygulama sınırlaması gibi çalışma zamanı bileşenlerini etkinleştirmek için Apigee Mesaj İşleyicisi'ni güncellemek üzere apigee-setup yardımcı programını kullanın. Birden fazla Mesaj İşleyiciniz varsa hepsine Para Kazanma'yı yükleyin.
  • Edge kuruluşlarınız için Para Kazanma'ya ilk katılım sürecini gerçekleştirin.
  • Para kazanmayı desteklemek için Apigee Geliştirici Hizmetleri portalını (veya portalı) yapılandırın. Daha fazla bilgi için Geliştirici Portalı'nda Para Kazanma'yı yapılandırma bölümüne bakın.

Para kazanma için sessiz bir yapılandırma dosyası oluşturma

Aşağıda, Monetization kurulumu için örnek bir sessiz yapılandırma dosyası gösterilmektedir. Bu dosyayı yapılandırmanız için gereken şekilde düzenleyin. Bu dosyayı eklemek üzere setup.sh dosyasını eklemek için -f seçeneğini kullanı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.
# 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>"

Notlar:

  • Edge yapılandırma dosyanızda SMTP bilgileri belirtilmemişse dosyayı ekleyin. Para kazanma özelliği için SMTP sunucusu gerekir.
  • Tek bir veri merkezi kurulumunda tek sayıda ZooKeeper düğümü voters olarak yapılandırılmalıdır. Çok sayıda ZooKeeper düğümü çift sayıysa bazı düğümler observers olarak yapılandırılır. Edge'i çift sayıda veri merkezine yüklerken seçmen düğümlerinin sayısını tek hale getirmek için bazı ZooKeeper düğümleri observers olarak yapılandırılmalıdır. ZooKeeper lider seçimi sırasında bir seçmen düğümü leader olarak seçilir. Yukarıdaki ZK_HOSTS özelliğinin, çoklu veri merkezi kurulumunda lider düğüm belirttiğinden emin olun.
  • Cassandra kimlik doğrulamasını etkinleştirirseniz aşağıdaki özellikleri kullanarak Cassandra kullanıcı adını ve şifresini iletebilirsiniz: 
    CASS_USERNAME
CASS_PASSWORD

Para Kazanma Hizmetleri'ni tüm yönetim sunucularıyla entegre etme

Yönetim Sunucusu düğümlerinde para kazanma özelliğini entegre etmek için aşağıdaki prosedürü kullanın.

  1. Para Kazanma özelliğini, 13 düğümlü yükleme gibi birden fazla Yönetim Sunucusu düğümü kullanan bir Edge topolojisine yüklüyorsanız Para Kazanma'yı yüklemeden önce her iki Yönetim Sunucusu düğümünü de yüklediğinizden emin olun.
  2. Yönetim Sunucusu düğümünde kurulum komut dosyasını çalıştırın:
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    -p mo seçeneği, para kazanma özelliğinin entegre edilip edilmeyeceğini belirtir.

    Yapılandırma dosyası, "Apigee" kullanıcısı tarafından erişilebilir ve okunabilir olmalıdır.

  3. Para Kazanma özelliğini birden fazla Yönetim Sunucusu düğümüne yüklüyorsanız ikinci Yönetim Sunucusu düğümünde 2. adımı tekrarlayın.

Başarılı yapılandırmada, PostgreSQL veritabanında Para Kazanma Hizmetleri için bir RDBMS şeması oluşturulur. Bu işlem, Para Kazanma Hizmetleri'nin ve ilişkili bileşenlerinin Postgres Sunucusu ile entegrasyonunu tamamlar.

Para Kazanma Hizmetleri'ni tüm Mesaj İşleyicilere entegre edin

Para kazanmayı tüm Mesaj İşleyici düğümlerine entegre etmek için aşağıdaki prosedürü kullanın.

  1. İlk Mesaj İşleyici düğümünde, komut isteminde şu kurulum komut dosyasını çalıştırın: 
    /opt/apigee/apigee-setup/bin/setup.sh -p mo -f configFile

    -p mo seçeneği, para kazanma özelliğinin entegre edilip edilmeyeceğini belirtir.

    Yapılandırma dosyası, "Apigee" kullanıcısı tarafından erişilebilir ve okunabilir olmalıdır.

  2. Bu prosedürü tüm İleti İşleyici düğümlerinde tekrarlayın.

Başarılı yapılandırma sonrasında Mesaj İşleyici, Para Kazanma Hizmetleri ile güncellenir. Bu işlem, Para Kazanma Hizmetleri'nin ve ilişkili bileşenlerinin Mesaj İşleyiciler ile entegrasyonunu tamamlar.

Para kazanmaya ilk katılım

Yeni bir kuruluş oluşturmak ve para kazanma özelliğini etkinleştirmek için:

  1. Kuruluşu, yeni kuruluşlarda olduğu gibi oluşturun. Daha fazla bilgi için Kuruluşa katılma başlıklı makaleyi inceleyin.
  2. Para kazanma sağlama API'sini Kuruluş için para kazanma özelliğini etkinleştirme bölümünde açıklandığı şekilde kullanın. Bunu yapmak için sistem yöneticisi ayrıcalıklarına sahip olmanız gerekir.

Edge kullanıcı arayüzüne bir sonraki giriş yaptığınızda, kuruluşun üst düzey menüsünde Para Kazanma girişini görürsünüz:

Portalı para kazanma özelliğini destekleyecek şekilde yapılandırmak için Geliştirici portalında Para Kazanma'yı yapılandırma bölümüne bakın.

Para kazanma kurulumuna Yönetim Sunucusu düğümü ekleme

Mevcut bir uç kurulumuna Yönetim Sunucusu eklerseniz yeni Yönetim Sunucusu'na Para Kazanma hizmetleri eklediğinizden ve tüm Yönetim Sunucularını iletişim kurabilecekleri şekilde yapılandırdığınızdan emin olun.

Yönetim Sunucusu eklemek için:

  1. Yeni Yönetim Sunucusu'nu yükleyin.
  2. Yeni Yönetim Sunucusu'na Para Kazanma'yı yükleyin.
  3. Orijinal Yönetim Sunucusu'nda aşağıdaki komutu çağırın: 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. Orijinal Yönetim Sunucusu'nu yeniden başlatın: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. Yeni Yönetim Sunucusu'nda aşağıdaki komutu çağırın: 
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. Yeni Yönetim Sunucusu'nu yeniden başlatın: 
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart

Ek yapılandırma

Faturalandırma belgelerini PDF dosyası olarak sağlayın

Para Kazanma, faturalandırma dokümanlarını son kullanıcılara HTML biçiminde gösterir. Faturalandırma belgelerini PDF dosyası olarak sağlamak için Monetization'ı PDF oluşturma olanağı sunan bir faturalandırma sistemiyle entegre edebilir veya desteklenen bir üçüncü taraf PDF kitaplığını lisanslayabilirsiniz.

Kuruluş ayarlarını yapılandırma

Kuruluş özellikleri eklemek/güncellemek için aşağıdaki örnekte gösterildiği gibi bir PUT isteği kullanabilirsiniz:

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

Para kazanma özelliği, kuruluşun ayarlarıyla yanıtlanır. Örneğin:

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

Aşağıdaki tabloda, bir mint kuruluşu yapılandırmak için kullanılabilecek kuruluş düzeyindeki özellikler listelenmiştir.

Özellikler Açıklama
MINT_TAX_MODEL

Kabul edilen değerler: "DISCLOSED", "UNDISCLOSED", "HYBRID" (varsayılan değer null)
MINT_CURRENCY

ISO para birimi kodu (varsayılan değer boştur)
MINT_TAX_NEXUS

Vergi bağlantı noktası (varsayılan değer boştur)
MINT_DEFAULT_PROD_TAX_CATEGORY

Varsayılan ürün vergi kategorisi (varsayılan değer boştur)
MINT_IS_GROUP_ORG

GP grubu kuruluşu (varsayılan "false")
MINT_HAS_BROKER

Bozuk (varsayılan değer yanlıştır)
MINT_TIMEZONE

Saat dilimi (varsayılan değer null)
MINT_TAX_ENGINE_EXTERNAL_ID

Vergi motoru kimliği (varsayılan değer, boştur)
MINT_COUNTRY

Kuruluşun ülkesi (varsayılan değer boştur)
MINT_REG_NO

Kuruluşun tescil numarası, Birleşik Krallık'ta vergi numarasından farklı bir numara verilir (varsayılan değer boştur)
MINT_BILLING_CYCLE_TYPE

"PRORATED", "CALENDAR_MONTH" (varsayılan değer: "CALENDAR_MONTH")
MINT_SUPPORTED_BILLING_TYPE

"PREPAID"/"POSTPAID"/"BOTH" (varsayılan "PREPAID"dir)
MINT_IS_SEPARATE_INV_FOR_FEES

Ayrı bir ücret faturasının oluşturulup oluşturulmayacağını belirtir (varsayılan değer "false")
MINT_ISSUE_NETTING_STMT

Ağ ifadesinin yayınlanıp yayınlanmayacağını belirtir (varsayılan değer "yanlış"tır)
MINT_NETTING_STMT_PER_CURRENCY

Ağ ifadesinin para birimi başına oluşturulup oluşturulmayacağını belirtir (varsayılan değer "false"tur)
MINT_HAS_SELF_BILLING

Kuruluşun kendi kendine faturalandırma özelliğine sahip olup olmadığını belirtir (varsayılan değer "false")
MINT_SELF_BILLING_FOR_ALL_DEV

Kuruluşun tüm geliştiriciler için kendi kendine faturalandırma kullanıp kullanmadığını belirtir (varsayılan değer "false")
MINT_HAS_SEPARATE_INV_FOR_PROD

Kuruluşun her ürün için ayrı faturası olup olmadığını belirtir (varsayılan değer "false")
MINT_HAS_BILLING_ADJUSTMENT

Kuruluşun fatura ayarlamalarını destekleyip desteklemediğini belirtir (varsayılan değer "false")
features.isMonetizationEnabled

Para kazanmaya özel menüyü görüntülemek için yönetim kullanıcı arayüzü tarafından kullanılır (varsayılan değer "false")
ui.config.isOperator

Sağlayıcıyı Operatör Operatörü Kuruluşa dökerek görüntülemek için yönetim kullanıcı arayüzü tarafından kullanılır (varsayılan değer "true" şeklindedir)

Yönetim kullanıcı arayüzünü kullanarak işletme kuruluş ayarlarını yapılandırmak için Edge'de para kazanma erişimi konusuna bakın.

Para kazanma sınırları

Para kazanma sınırları uygulamak için API proxy'lerine Para Kazanma Sınırları Kontrolü politikasını ekleyin. Politika özellikle aşağıdaki koşullar altında tetiklenir:

  • Para kazanma API'sine erişen geliştirici, kayıtlı değil veya ücret planına abone değil.
  • Geliştirici, abone olunan ücret planı için işlem hacmini aştı.
  • Geliştirici ön ödemeli hesap bakiyesine veya faturalı kredi limitine ulaşıldı.

Para Kazanma Sınırları Kontrolü politikası, yukarıda listelenenler gibi durumlarda hataları bildirir ve API çağrılarını engeller. Bu politika, Hata Oluştur politikasının kapsamını genişletir ve döndürülen mesajı özelleştirebilirsiniz. Geçerli koşullar işletme değişkenlerinden türetilir.

Daha fazla bilgi için API proxy'lerinde para kazanma sınırlarını zorunlu kılma konusuna bakın.