Para Kazanma Hizmetlerini Yükleme

Para Kazanma Hizmetleri, Apigee Edge'in bir uzantısıdır. Bu nedenle, bağımsız bir işlem olarak çalışmaz. All-In-One (AIO) yapılandırması hariç olmak üzere mevcut tüm Apigee Edge kurulumlarında çalışır. Para Kazanma Hizmetleri'ni hepsi bir arada yapılandırmasına yükleyemezsiniz.

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.
  • Para kazanma özelliği, All-In-One (AIO) yapılandırmasında kullanılamaz.

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.

    13 düğümlü bir kurulum gibi birden fazla Yönetim Sunucusu düğümünüz varsa Monetization'ı yüklemeden önce her iki Edge Yönetim Sunucusu 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
  • Apigee Developer Services portalını (veya kısaca portalı) para kazanmayı destekleyecek şekilde yapılandırın. Daha fazla bilgi için Geliştirici portalında para kazanma özelliğini yapılandırma başlıklı makaleyi inceleyin.

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.

# 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 bu bilgileri ekleyin. Para kazanma için bir SMTP sunucusu gerekir.
  • Tek bir veri merkezi kurulumunda, tek sayılı ZooKeeper düğümleri voters olarak yapılandırılmalıdır. ZooKeeper düğümlerinin sayısı çiftse 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 yapmak için bazı ZooKeeper düğümlerinin observers olarak yapılandırılması gerekir. ZooKeeper lider seçimi sırasında bir seçmen düğümü leader olarak seçilir. 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, para kazanma özelliğini entegre etmeyi 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 özelliğini entegre etmeyi 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ğine ilk katılım

Yeni bir kuruluş oluşturmak ve para kazanmayı etkinleştirmek için:

  1. Kuruluşu, yeni bir kuruluş oluşturur gibi oluşturun. Daha fazla bilgi için Kuruluşun ilk katılımını gerçekleştirme başlıklı makaleyi inceleyin.
  2. Para kazanma temel hazırlık API'sini Bir kuruluş için para kazanmayı etkinleştirme bölümünde açıklandığı şekilde kullanın. Bunun için sistem yöneticisi ayrıcalıklarına sahip olmanız gerekir.

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:

Portalı para kazanmayı destekleyecek şekilde yapılandırmak için Geliştirici portalında para kazanmayı yapılandırma başlıklı makaleyi inceleyin.

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ğıdakileri çağırın:
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  4. Orijinal yönetim sunucusunu yeniden başlatın:
    /opt/apigee/apigee-service/bin/apigee-service edge-management-server restart
  5. Yeni yönetim sunucusunda aşağıdakileri çağırın:
    /opt/apigee/apigee-service/bin/apigee-service edge-mint-management-server mint-configure-mgmt-cluster
  6. Yeni yönetim sunucusunu 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ğlama

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

Kuruluş özelliklerini 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, kuruluşun ayarlarıyla yanıt verir. Ö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şunu yapılandırmak için kullanılabilen kuruluş düzeyindeki özellikler listelenmiştir.

Özellikler Açıklama
MINT_TAX_MODEL

Kabul edilen değerler: "DISCLOSED", "UNDISCLOSED", "HYBRID" (varsayılan değer boştur)

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 (varsayılan değer "false"dur)

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 "CALENDAR_MONTH" değeridir)

MINT_SUPPORTED_BILLING_TYPE

"PREPAID"/"POSTPAID"/"BOTH" (varsayılan değer "PREPAID"dir)

MINT_IS_SEPARATE_INV_FOR_FEES

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

MINT_ISSUE_NETTING_STMT

Mahsup 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ı belirtir (varsayılan değer "false"dur).

MINT_HAS_SELF_BILLING

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

MINT_SELF_BILLING_FOR_ALL_DEV

Kuruluşun tüm geliştiriciler için kendi kendine faturalandırma yapıp yapmadığını gösterir (varsayılan değer "false"dur)

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"tur).

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"dur)

Yönetim kullanıcı arayüzünü kullanarak işletme kuruluşu ayarlarını yapılandırmak için Edge'de para kazanma özelliğine erişme başlıklı makaleyi inceleyin.

Para kazanma sınırları

Para kazanma sınırlarını uygulamak için Monetization Limits Check politikasını API proxy'lerine ekleyin. Politika, özellikle aşağıdaki koşullarda tetiklenir:

  • Ücretli API'ye erişen geliştirici kayıtlı değil veya ücret planına abone olmamış.
  • Geliştirici, abone olunan ücret planı için işlem hacmini aştı.
  • Geliştiricinin ön ödemeli hesap bakiyesine veya sonradan ödemeli 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. Politika, Raise Fault politikası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 başlıklı makaleyi inceleyin.