Para Kazanma Hizmetlerini Yükleme

Para kazanma hizmetleri, Apigee Edge'in bir uzantısı olduğundan bağımsız bir işlem olarak çalışmaz. Hepsi Bir Arada (AIO) yapılandırması hariç, mevcut tüm Apigee Edge kurulumlarında çalışır. Para kazanma hizmetlerini hepsi bir arada yapılandırmaya yükleyemezsiniz.

Para kazanma koşulları

  • Para Kazanma'yı, birden fazla Yönetim Sunucusu düğümü kullanan bir Edge topolojisine (ör. 13 düğümlü 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ü varsa Para Kazanma'yı Edge'e yüklemek için Postgres düğümlerinin Ana/Bekleme modunda yapılandırılması gerekir. Birden fazla Postgres ana düğümünüz varsa Monetization'ı Edge'de yükleyemezsiniz. Daha fazla bilgi için Postgres için Ana-Yedek Kopyalama ayarlama başlıklı makaleyi inceleyin.
  • Hepsi Bir Arada (AIO) yapılandırmasıyla para kazanma özelliği 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 hizmetlerini (ör. katalog yönetimi, sınırlar ve bildirimler yapılandırması, faturalandırma ve raporlama) etkinleştirmek için Apigee Management Server düğümünü güncellemek üzere apigee-setup yardımcı programını kullanın.

    13 düğümlü bir kurulum gibi birden fazla Yönetim Sunucusu düğümünüz varsa Para Kazanma'yı yüklemeden önce her iki Edge Yönetim Sunucusu düğümünü de yüklemeniz gerekir.

  • Para kazanma hizmetlerinin çalışma zamanı bileşenlerini (ör. işlem kaydı politikası ve sınır yaptırımı) etkinleştirmek için Apigee Mesaj İşlemcisini güncellemek üzere apigee-setup yardımcı programını kullanın. Birden fazla Mesaj İşleyiciniz varsa hepsine Monetization'ı yükleyin.
  • Edge kuruluşlarınız için para kazanma oryantasyon sürecini tamamlayın.
  • Para kazanma özelliğini desteklemek için Apigee Developer Services portalını (veya kısaca portalı) yapılandırın. Daha fazla bilgi için Geliştirici Portalı'nda Para Kazanma'yı yapılandırma başlıklı makaleyi inceleyin.

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

Aşağıda, para kazanma 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ı dahil etmek 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 belirtilmediyse bunları ekleyin. Para kazanmak 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ı çift ise bazı düğümler observers olarak yapılandırılır. Edge'i çift sayıda veri merkezine kurarken, oy veren düğüm sayısını tek sayıya getirmek için bazı ZooKeeper düğümleri observers olarak yapılandırılmalıdır. ZooKeeper lider seçimi sırasında bir oy veren düğüm leader olarak seçilir. Yukarıdaki ZK_HOSTS mülkünün, 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 hizmetlerini tüm yönetim sunucularıyla entegre edin

Para kazanma özelliğini Yönetim sunucusu düğümlerine entegre etmek için aşağıdaki prosedürü uygulayın.

  1. Para Kazanma'yı, birden fazla Yönetim Sunucusu düğümü kullanan bir Edge topolojisine (ör. 13 düğümlü kurulum) 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'nın entegre edileceğini belirtir.

    Yapılandırma dosyasına "apigee" kullanıcısı tarafından erişilebilmelidir veya dosya 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.

Başarılı yapılandırmanın ardından PostgreSQL veritabanında Para Kazanma Hizmetleri için bir R DBMS şeması oluşturulur. Bu işlem, Para Kazanma Hizmetleri ve ilişkili bileşenlerinin Postgres sunucusuyla entegrasyonunu tamamlar.

Para Kazanma Hizmetleri'ni tüm Mesaj İşleyiciler ile entegre etme

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

  1. İlk Mesaj İşleyen 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ğinin entegre edileceğini belirtir.

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

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

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

Para kazanmaya 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şta ilk katılım bölümünü inceleyin.
  2. Kuruluş için para kazanmayı etkinleştirme bölümünde açıklandığı şekilde para kazanma temel hazırlık API'sini kullanın. Bunu yapmak için sistem yöneticisi ayrıcalıklarına sahip olmanız gerekir.

Edge kullanıcı arayüzüne tekrar giriş yaptığınızda, 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 Sunucusu'na para kazanma hizmetlerini eklediğinizden ve tüm Yönetim Sunucularını iletişim kurabilecekleri şekilde yapılandırdığınızdan emin olmanız gerekir.

Yönetim sunucusu eklemek için:

  1. Yeni Yönetim Sunucusu'nu yükleyin.
  2. Para Kazanma'yı yeni Yönetim Sunucusu'na 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 Sunucusu'nda şunu ç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 dokümanlarını PDF dosyası olarak gönderin

Para kazanma, faturalandırma dokümanlarını son kullanıcılara HTML biçiminde gösterir. Fatura belgelerini PDF dosyası olarak sağlamak için Para Kazanma'yı PDF oluşturma hizmeti 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ına göre 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, madeni para 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 null)
MINT_CURRENCY

ISO para birimi kodu (varsayılan olarak null)
MINT_TAX_NEXUS

Vergi bağlantısı (varsayılan değer null'dur)
MINT_DEFAULT_PROD_TAX_CATEGORY

Varsayılan ürün vergisi kategorisi (varsayılan olarak null)
MINT_IS_GROUP_ORG

IS grubu organizasyonu (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 olarak null)
MINT_COUNTRY

Kuruluşun ülkesi (varsayılan değer null'dur)
MINT_REG_NO

Kuruluşun tescil numarası (Birleşik Krallık, vergi numarasından farklı bir numara verir) (varsayılan değer null'dur)
MINT_BILLING_CYCLE_TYPE

"PRORATED", "CALENDAR_MONTH" (varsayılan ayar "CALENDAR_MONTH")
MINT_SUPPORTED_BILLING_TYPE

"PREPAID"/"POSTPAID"/"BOTH" (varsayılan değer "PREPAID" şeklindedir)
MINT_IS_SEPARATE_INV_FOR_FEES

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

Netting deyiminin yayınlanıp yayınlanmayacağını belirtir (varsayılan değer "false"tur)
MINT_NETTING_STMT_PER_CURRENCY

Netleştirme beyanının para birimi başına oluşturulup oluşturulmayacağını belirtir (varsayılan değer "false").
MINT_HAS_SELF_BILLING

Kuruluşun kendi kendine faturalandırma özelliğinin 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 ürün başına 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"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

Sağlayıcıyı Operatör ve Kuruluş olarak görüntülemek için yönetim kullanıcı arayüzü tarafından 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 Para Kazanma Sınırları Kontrolü politikasını API proxy'lerine ekleyin. Daha ayrıntılı olarak belirtmek gerekirse politika aşağıdaki koşullarda tetiklenir:

  • Para kazandıran API'ye erişen geliştirici kayıtlı değil veya ücret planına abone değil.
  • Geliştirici, abone olunan ücret planının işlem hacmini aştı.
  • Geliştiricinin ön ödemeli hesap bakiyesine veya faturalı kredi sınırına ulaşıldı.

Para Kazanma Sınırları Kontrolü politikası, yukarıda listelenenler gibi durumlarda hataları artırır ve API çağrılarını engeller. Politika, Hata Bildir 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ı uygulama başlıklı makaleyi inceleyin.