Para Kazanma Hizmetlerini Yükleme

Edge for Private Cloud sürüm 4.17.05

Para Kazanma Hizmetleri, Apigee Edge'in bir uzantısıdır. Bu nedenle, bağımsız bir işlem olarak çalışmaz. Mevcut Apigee Edge kurulumlarında çalışır.

Para kazanma koşulları

  • Para Kazanma'yı birden fazla Yönetim Sunucusu düğümü kullanan bir Edge topolojisine (ör. 13 düğümlü bir kurulum) yüklüyorsanız Para Kazanma'yı yüklemeden önce her iki Edge Yönetim Sunucusu düğümünü de yüklemeniz gerekir.
  • Edge kurulumunda birden fazla Postgres düğümü bulunan Edge'de Monetization'ı 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 Monetization'ı yükleyemezsiniz. Daha fazla bilgi için Postgres için ana-yedek replikasyonunu ayarlama başlıklı makaleyi inceleyin.

Yüklemeye genel bakış

Aşağıdaki adımlarda, mevcut bir 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ırması, faturalandırma ve raporlama) etkinleştirmek üzere Apigee Management Server düğümünü güncellemek için apigee-setup yardımcı programını kullanın.

    Birden fazla Management Server düğümünüz varsa (ör. 13 düğümlü bir kurulum) Monetization'ı yüklemeden önce her iki Edge Management Server düğümünü de yüklemeniz gerekir.
  • Para Kazanma Hizmetleri'nin çalışma zamanı bileşenlerini (ör. işlem kaydetme politikası ve sınır yaptırımı) etkinleştirmek üzere Apigee Mesaj İşleyici'yi güncellemek için apigee-setup yardımcı programını kullanın. Birden fazla Mesaj İşlemciniz varsa Monetization'ı hepsine yükleyin.
  • Edge kuruluşlarınız için para kazanma oryantasyon sürecini gerçekleştirme
  • Geliştirici Hizmetleri portalını para kazanmayı destekleyecek şekilde yapılandırma Daha fazla bilgi için http://apigee.com/docs/monetization/content/configure-monetization-developer-portal adresini ziyaret edin.

Para Kazanma için sessiz 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 gerektiği şekilde düzenleyin. Bu dosyayı eklemek için setup.sh dosyasında -f seçeneğini kullanın.

Not: Genellikle bu özellikleri, Edge bileşenlerini bir düğüme yükleme bölümünde gösterildiği gibi Edge'i yüklemek için kullandığınız yapılandırma dosyasına eklersiniz.

# 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>"
Notlar:
  • Edge yapılandırma dosyanızda SMTP bilgileri belirtilmemişse bu bilgileri ekleyin. Para kazanma için SMTP sunucusu gerekir.
  • Tek bir veri merkezi kurulumunda, tüm ZooKeeper düğümleri varsayılan olarak lider olarak yapılandırılır. Edge'i birden fazla veri merkezine yüklerken bazı ZooKeeper düğümleri gözlemci olarak yapılandırılır. Yukarıdaki ZK_HOSTS özelliğinin, birden fazla veri merkezi kurulumunda bir 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 birden fazla Yönetim Sunucusu düğümü kullanan bir Edge topolojisine (ör. 13 düğümlü bir kurulum) yüklüyorsanız Para Kazanma özelliğini 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, Monetization'ın entegre edileceğini belirtir.

    Yapılandırma dosyası, "apigee" kullanıcısı tarafından erişilebilir veya okunabilir olmalıdır.
  3. Para Kazanma'yı birden fazla Yönetim Sunucusu düğümüne yüklüyorsanız ikinci Yönetim Sunucusu düğümünde 2. adımı tekrarlayın.

Yapılandırma başarılı olursa PostgreSQL veritabanında Monetization Services 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 işlemcilerle entegre etme

Para kazanma özelliğini 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 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'nın entegre edileceğini belirtir.

    Yapılandırma dosyası, "apigee" kullanıcısı tarafından erişilebilir veya okunabilir olmalıdır.
  2. Bu prosedürü tüm Mesaj İşleyici düğümlerinde tekrarlayın.

Yapılandırma başarılı olduğunda Mesaj İşleyici, Monetization Services ile güncellenir. Bu işlem, Para Kazanma Hizmetleri'nin ve ilişkili bileşenlerinin Mesaj İşlemciler ile entegrasyonunu tamamlar.

Para Kazanma Özelliğini Kullanmaya Başlama

Para kazanma özelliğinin etkin olduğu yeni bir kuruluş oluşturmak için önce kuruluşu diğer yeni kuruluşlarda olduğu gibi oluşturursunuz. Daha fazla bilgi için Kuruluşun ilk katılımını gerçekleştirme başlıklı makaleyi inceleyin.

Bir kuruluş için para kazanmayı etkinleştirmek üzere ek oryantasyon

Bir kuruluşun para kazanma özelliğine ilk katılımını tamamlamak için şunları yapmanız gerekir:

  1. Para kazanma grubunu oluşturun: mxgroup.
  2. Qpid'yi gruba ekleyin.
  3. Kuruluş için para kazanma özelliğini etkinleştirin.
  4. Kuruluş için bildirim ayarlarını etkinleştirin.
  5. Para kazanma özelliğini etkinleştirmek istediğiniz tüm kuruluşlar için bu işlemi tekrarlayın.

Tüm bu görevleri gerçekleştirmek için enable-monetization komutunu kullanın. Bu komut dosyası, aşağıdaki özellikleri içeren bir yapılandırma dosyası alır:

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.

Notlar:

  • CASS_HOSTS ve REGION değerlerini, Monetization'ı yüklerken kullandığınız değerlerle aynı olacak şekilde ayarlayın.
  • Para Kazanma'yı birden fazla veri merkezi yapılandırmasında etkinleştiriyorsanız:
    • Her veri merkezindeki yönetim sunucusunda ilk katılım sürecini tekrarlamanız gerekir.
    • Yapılandırma dosyasında yalnızca yapılandırılan veri merkezindeki Qpid düğümleri listelenmelidir.

Komut dosyasını çalıştırmak için:

  1. Komut dosyasını çağırın:
    > /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-monetization -f configFile

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

    Birden fazla yönetim sunucunuz varsa bu komut dosyasını yalnızca birinde çalıştırmanız gerekir.

    Bu komut dosyası; kuruluşu, ürünleri, geliştiricileri ve uygulamaları Cassandra veritabanından Monetization PostgreSQL veritabanına kopyalar. Para Kazanma Hizmetleri başarıyla yüklendikten sonra veriler otomatik olarak senkronize edilir.
  2. Para Kazanma'yı etkinleştirmek istediğiniz her kuruluş için bu prosedürü tekrarlayın.
  3. Birden fazla veri merkezinin bulunduğu bir ortamda çalışıyorsanız bu işlemi diğer veri merkezindeki yönetim sunucusunda tekrarlayın. Yapılandırma dosyasında yalnızca yapılandırılan veri merkezindeki Qpid düğümlerinin listelendiğinden emin olun.

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

Geliştirici Hizmetleri portalını yapılandırma

Geliştirici Hizmetleri portalını para kazanmayı destekleyecek şekilde yapılandırmak için http://apigee.com/docs/monetization/content/configure-monetization-developer-portal adresini ziyaret edin.

Para Kazanma Kurulumuna Yönetim Sunucusu Düğümü Ekleme

Mevcut bir Edge kurulumuna yönetim sunucusu eklerseniz yeni yönetim sunucusuna para kazanma hizmetlerini eklediğinizden ve tüm yönetim sunucularını iletişim kurabilecek şekilde yapılandırdığınızdan emin olmanız gerekir.

Yönetim sunucusu eklemek için:

  1. Yeni Management Server'ı yükleyin.
  2. Yeni yönetim sunucusuna Monetization'ı yükleyin.
  3. Orijinal yönetim sunucusunda aşağıdakini çağırın:
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. Orijinal Management Server'ı yeniden başlatın:
    > /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. Yeni yönetim sunucusunda aşağıdakini çağırın:
    > /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. Yeni Management Server'ı 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 gönderme

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

Kuruluş ayarlarını yapılandırma

Arka uç ayarları: Aşağıdaki tabloda, yeni bir kuruluş yapılandırmak için kullanılabilen kuruluş düzeyindeki özellikler listelenmiştir. Bu özellikleri aşağıda gösterildiği gibi eklemek/güncellemek için PUT çağrısı kullanabilirsiniz:

> curl -u ${ADMIN_EMAIL}:${ADMINPW} -v http://<management-ip>:8080/v1/organizations/{orgId} -d '{org object with attributes}' -X PUT

Örneğin, yukarıdaki CURL komutunun çıkışı aşağıdaki gibi görünür:

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

Özellikler

Açıklama

MINT_TAX_MODEL

Kabul edilen değerler: DISCLOSED,

UNDISCLOSED, HYBRID (varsayılan değer null'dur)

MINT_CURRENCY

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

MINT_TAX_NEXUS

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

MINT_DEFAULT_PROD_TAX_CATEGORY

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

MINT_IS_GROUP_ORG

Grup kuruluşu mu? (Varsayılan değer: false)

MINT_HAS_BROKER

Has broken (varsayılan değer: false)

MINT_TIMEZONE

Saat dilimi (varsayılan değer null'dur)

MINT_TAX_ENGINE_EXTERNAL_ID

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

MINT_COUNTRY

Kuruluşun bulunduğu ülke (varsayılan değer boştur)

MINT_REG_NO

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

MINT_BILLING_CYCLE_TYPE

PRORATED, CALENDAR_MONTH (varsayılan değer CALENDAR_MONTH'tur)

MINT_SUPPORTED_BILLING_TYPE

PREPAID/POSTPAID/BOTH (varsayılan: PREPAID)

MINT_IS_SEPARATE_INV_FOR_FEES

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

MINT_ISSUE_NETTING_STMT

Netleştirme ekstresinin düzenlenip düzenlenmeyeceğini belirtir (varsayılan değer "false"dur).

MINT_NETTING_STMT_PER_CURRENCY

Netleştirme ekstresinin para birimi başına oluşturulup oluşturulmayacağını gösterir (varsayılan değer false'tur).

MINT_HAS_SELF_BILLING

Kuruluşun kendi kendine faturalandırma yapıp yapmadığını gösterir (varsayılan değer false'tur).

MINT_SELF_BILLING_FOR_ALL_DEV

Kuruluşun tüm geliştiriciler için öz faturalandırma kullanıp kullanmadığını gösterir(varsayılan değer false'tur).

MINT_HAS_SEPARATE_INV_FOR_PROD

Kuruluşun her ürün için ayrı faturası olup olmadığını gösterir (varsayılan değer false'tur)

MINT_HAS_BILLING_ADJUSTMENT

Kuruluşun fatura ayarlamalarını destekleyip desteklemediğini gösterir (varsayılan değer "false"dur).

features.isMonetizationEnabled

Yönetim kullanıcı arayüzü tarafından para kazanmaya özel menüyü görüntülemek için kullanılır (varsayılan değer false'tur).

ui.config.isOperator

Yönetim kullanıcı arayüzü tarafından, sağlayıcıyı Operatör veya Kuruluş olarak göstermek için kullanılır.

(varsayılan değer: true)

Yönetim kullanıcı arayüzünü kullanarak işletme kuruluşu ayarlarını yapılandırma hakkında bilgi için http://apigee.com/docs/monetization-services/content/get-started-using-monetization-services adresini ziyaret edin.

Not: Monetization Services Limits and Notifications özelliklerini kullanıyorsanız lütfen geliştiricilerinize, erişim jetonu doğrulama politikasından sonra proxy akışına bir sınır politikası eklemeleri talimatını verin.

Sınır politikası, belirli bir sınıra ulaşıldığında API çağrısını engellemek için tasarlanmış açık bir politikadır. Politika, işletme sınırlarını kontrol eder ve yapılandırılan değeri aşan sınırlar varsa hata verir. Bu, hata oluşturma politikasının bir uzantısıdır ancak koşullar işletme değişkenlerinden türetilir.

Proxy geliştiricileri için yönetim kullanıcı arayüzünde bir kullanıcı arayüzü şablonu bulunur. Proxy geliştiricisi, mesaj akışına mint politikasını eklemelidir. Bu politika yürütüldüğünde, politikaya göre hata yanıtıyla birlikte hata oluşturulur. ContinueOnError, true olarak ayarlanırsa hata oluşturulmaz ve "mint.limitsViolated", "mint.isDeveloperSuspended" ve "mint.limitsPolicyError" akış değişkenleri ayarlanır. Bu değişkenler, gerekirse daha fazla istisna işleme için kullanılabilir.