İşlem kaydetme politikasını yapılandırma

Apigee Edge belgelerini görüntülüyorsunuz.
. Git: Apigee X belgeleri. bilgi

API ürün paketinizdeki her API ürünü için işlem kaydetme politikalarını aşağıdaki bölümlerde açıklandığı şekilde yapılandırın.

Giriş

İşlem kayıt politikası, para kazanma özelliğinin işlem parametrelerini ve özel özellikler. Para kazanma özelliğinin, para kazanma işlemlerini gerçekleştirmesi için bu bilgilere ihtiyacı vardır. müzakere tekniklerini konuşacağız.

Örneğin, bir gelir paylaşımı ücret planı ayarlarsanız Para kazanılan API ürününüzün dahil olduğu her işlemden elde edilen gelirin paylaşılması isteği veren uygulamanın geliştiricisiyle iletişim kurun. Gelir paylaşımı, net veya brüt gelire göre işlemin fiyatı (hangisini siz belirtirsiniz?) yani brüt veya net fiyatın bir yüzdesidir. değeri, gelir paylaşımını belirlemek için kullanılır. Bu nedenle, para kazanma bir işlemin brüt veya net fiyatını (hangisi geçerliyse) bilmek. Brüt veya net fiyatı alır. bazı ayarları değiştirebilirsiniz.

Ücret listesi ayarlarsanız her işlem için geliştiriciden ödeme aldığınız bir planda, planın ücretini bir işlemde aktarılan bayt sayısı gibi özel bir özelliğe göre değişir. Para kazanma özelliğinin, özel özelliğin ne olduğunu ve nerede bulunabileceğini bilmesi gerekir. Bu yüzden özel özelliği işlem kaydetme politikasında belirtmesi gerekir.

İşlem kaydetme politikasında işlem özelliklerini belirtmenin yanı sıra şunları da yapabilirsiniz: bir işlemin ne zaman başarılı olduğunu belirlemek için işlem başarı kriterlerini belirtmek (örneğin, şarj etmeme nedenlerinden ötürü). İşlem başarı kriterlerinin belirlenmesiyle ilgili örnekler için İşlem kaydında işlem başarı kriterlerini ayarlama örnekleri politikasına tabidir. Bir API ürünü için de özel özellikler belirtebilirsiniz ( plan ücretlerine tabidir).

İşlem kaydetme politikası yapılandırma

Aşağıda açıklandığı şekilde Ürün Paketleri sayfasına erişin.

İşlem özelliklerini yapılandırma

İşlem Özellikleri bölümünde, para kazanma işleminin başarılı olduğunu gösteren ölçütleri belirtin.

1. İşlem Başarı Ölçütleri alanında, Durum özelliğinin değerine dayalı olan ifadeyi belirtin. (daha sonra açıklanmıştır). Başarılı olmayan işlemler (yani ifadedeki ölçütleri karşılamazlar) kaydedilir, ancak ücret planları bunlara uygulanmaz. Örneğin:

   txProviderStatus == 'OK'

2. Status özelliği, İşlem Başarı Kriterleri alanına girin. Aşağıdaki alanları tanımlayarak Status özelliğini yapılandırın:

   Alan	Açıklama
   API Kaynağı	API ürününde tanımlanan ve para kazanılan işlemleri tanımlamak için kullanılacak URI kalıpları.
   Yanıt Konumu	Özelliğin belirtildiği yanıtın konumu. Geçerli değerler şunları içerir: Akış Değişkeni, Başlık, JSON Gövdesi ve XML Gövdesi.
   Değer	Yanıtın değeri. Birden fazla değer belirtmek için + Ekle x seçeneğini (örneğin, + Akış Değişkeni Ekle) tıklayın.

3. İsteğe bağlı işlem özelliklerini yapılandırmak için İsteğe Bağlı Özellikleri Kullan açma/kapatma düğmesini etkinleştirin ve yapılandırın. aşağıdaki tabloda tanımlanan işlem özelliklerinden herhangi biri.

   Özellik	Açıklama
   Brüt fiyat	Bu özellik yalnızca gelir paylaşımı modelini kullanan ücret planları için geçerlidir. Bu ücret planları için brüt fiyat veya net fiyat zorunludur. Lütfen sayısal değer, Dize türü olarak ifade edilir. Bir işlemin brüt fiyatı. Örneğin, bir gelir paylaşımı planları oluşturmak için, Brüt Fiyat özelliğini veya Net Fiyat özelliğini gönderin. Hangi özelliğin gerekli olduğu, gelir paylaşımına bağlıdır. Örneğin, bir aylık etkinin brüt fiyatını temel alan bir gelir paylaşımı ücret planı belirtir. Bu durumda, Brüt Fiyat alanı gereklidir.
   Net fiyat	Bu özellik yalnızca gelir paylaşımı modelini kullanan ücret planları için geçerlidir. Bu ücret planları için brüt fiyat veya net fiyat zorunludur. Lütfen sayısal değer, Dize türü olarak ifade edilir. Bir işlemin net fiyatı. Örneğin, bir gelir paylaşımı planları oluşturmak için, Net Fiyat alanını ya da Brüt Fiyat girin. Hangi alanın doldurulması, gelir paylaşımına bağlıdır. Örneğin, Bir işlemin net fiyatını temel alan bir gelir paylaşımı ücret planı oluşturabilirsiniz. Bu durumda, Net Fiyat alanı gereklidir.
   Para Birimi	Bu özellik, gelir paylaşımı modelini kullanan ücret planları için gereklidir. İşlem için geçerli para biriminin türü.
   Hata Kodu	İşlemle ilişkili hata kodu. Daha fazla Başarısız bir işlemle ilgili bilgi sağlar.
   Öğe Açıklaması	İşlemin açıklaması.
   Vergi	Bu özellik yalnızca gelir paylaşımı modelleriyle ve yalnızca vergi tutarı API çağrılarına dahil edilir. Sayısal değerin ifade edildiğinden emin olun girin. Satın alma işleminin vergi tutarı. Net fiyat artı vergi = brüt fiyat.

Örneğin, aşağıdaki değerler ayarlandığında para kazanma, response.reason.phrase adlı değişkeni kullanabilirsiniz. Değer Tamam ise ve Para Kazanma Sınırları Kontrolü politikası API proxy ProxyEndpoint isteğine eklenmişse para kazanma bunu bir işlem olarak sayar.

Özel özellikleri yapılandırma

Özel Özellikler bölümünde, İşlem kaydetme politikası. Örneğin, her abonelikte geliştiriciden ödeme aldığınız bir ücret listesi planın ücretini; bayt olarak ifade edilir. Daha sonra bu özel özelliği İşlem kaydetme politikası.

Bu özelliklerin her biri, sorgulayabileceğiniz işlem günlüğünde depolanır. Ayrıca ücret planı oluşturduğunuzda gösterilir (böylece, buna dahildir.

İşlem kaydetme politikasında tanımlanan özel özellikleri gelirinize ekleyebilirsiniz aşağıdaki şekilde açıklandığı üzere, Özel işlem dahil gelir özeti raporlarındaki özellikleri inceleyin.

Özel özellikleri yapılandırmak için Özel Özellikleri Kullan açma/kapatma düğmesini etkinleştirin ve özel özellik bulunuyor. İşlem kaydetme politikasına eklediğiniz her özel özellik için aşağıdaki bilgileri belirtmeniz gerekir.

Benzersiz işlem kimliğine sahip kaynakları bağlama

Bazı işlemler basittir ve bir kaynağa API çağrısı içerir. Ancak, diğer işlemler daha karmaşık olabilir. Örneğin, bir uygulama içi ürün satın alma işlemi birden fazla kaynak çağrısı içeriyor:

• Ön ödemeli bir kullanıcının satın alma işlemi için yeterli krediye sahip olmasını sağlayan Reserve API'ye yapılan çağrıdır. satın alır ve satın alma işlemi için para tahsis eder ("ayrılır").
• Ön ödemeli kullanıcının hesabından para çeken bir ödeme API'sine yapılan çağrı.

İşlemin tamamının yürütülmesi için para kazanma sürecinde ilk kaynağı ( (rezerve API'den gelen ve rezervasyon API'sinden gelen çağrı ve yanıt) ve ödeme API'sinden). Bunu yapmak için de Kaynakları Benzersiz İşlem Kimliği ile bağlayın.

Özel özellikleri yapılandırmak için Benzersiz İşlem Kimliklerini Kullan açma/kapatma düğmesini ve bağlantısını etkinleştirin. işlemlerdir. Her işlem için aşağıdaki özelliklere sahip bir kaynak, yanıt konumu ve özellik değeri belirtirsiniz: diğer işlemlerdir.

Örneğin, Reserve API çağrısı ile ücret API çağrısının şu şekilde bağlandığını varsayalım: Reserve API'nin yanıt başlığındaki session_id adlı alan ödeme API'sinden reference_id adlı yanıt başlığı. Bu durumda, bu tür durumlarda "Benzersiz İşlem Kimliği Olan Kaynakları Bağla" bölümünde aşağıdaki adımları uygulayın:

Geri ödemeleri yapılandırma

Geri ödemeler bölümünde şu özelliklere sahip para kazanma yöntemlerini, geri ödemeleri işlemek için kullanır.

Örneğin, bir kullanıcının para kazandıran API'lerinizi kullanan bir mobil uygulamadır. İşlemden, paylaşılan para birimine göre para kazanılır. gelir planı. Ancak kullanıcının üründen memnun olmadığını ve ürünü iade etmek istediğini varsayalım. Öğe ürünün geri ödemesi, API'nize yapılan ve geri ödemeyi yapan çağrı kullanılarak geri ödendiğinde, para kazanma para kazanmayla ilgili gerekli düzenlemeleri yapın. Bu, İşlem kaydetme politikasının Geri ödemeler bölümü

Geri ödemeleri yapılandırmak için Geri Ödeme Özelliklerini Kullan açma/kapatma düğmesini etkinleştirin ve geri ödeme ayrıntılarını tanımlayın:

1. Aşağıdaki alanları tanımlayarak geri ödeme ölçütlerini tanımlayın:

   Alan	Açıklama
   Yanıt Konumu	Geri ödeme işleminin kaynağı. API ürünü, birden çok kaynak varsa yalnızca geri ödemeyi gerçekleştirecek kaynağı seçebilirsiniz.
   Geri Ödeme Başarı Kriterleri	Değere dayalı ifade Geri ödeme işleminin ne zaman başarılı olduğunu (ödeme alma için) belirlemede kullanılan Durum özelliği (aşağıda açıklanmıştır) amacıyla). Başarılı olmayan (yani, ifadesi) kaydedilir, ancak ücret planları bunlara uygulanmaz. Örneğin: txProviderStatus == 'OK'

2. Aşağıdaki alanları tanımlayarak Status özelliğini yapılandırın:

   Alan	Açıklama
   Yanıt Konumu	Özelliğin belirtildiği yanıtın konumu. Geçerli değerler şunları içerir: Akış Değişkeni, Başlık, JSON Gövdesi ve XML Gövdesi.
   Değer	Yanıtın değeri. Birden fazla değer belirtmek için + Ekle x seçeneğini (örneğin, + Akış Değişkeni Ekle) tıklayın.

3. Aşağıdaki alanları tanımlayarak Parent ID özelliğini yapılandırın:

   Alan	Açıklama
   Yanıt Konumu	Özelliğin belirtildiği yanıtın konumu. Geçerli değerler şunları içerir: Akış Değişkeni, Başlık, JSON Gövdesi ve XML Gövdesi.
   Değer	Geri ödemenin işlendiği işlemin kimliği. Örneğin, bir kullanıcı bir ürün satın aldıktan sonra geri ödeme isteğinde bulunursa Ana İşlem Kimliği, satın alma işleminin kimliğidir. Birden fazla değer belirtmek için + Ekle x seçeneğini (örneğin, + Akış Değişkeni Ekle) tıklayın.

4. İsteğe bağlı geri ödeme özelliklerini yapılandırmak için İsteğe bağlı geri ödeme özelliklerini kullan açma/kapatma düğmesini etkinleştirin ve yapılandırın. özellikler. İsteğe bağlı geri ödeme özellikleri, İşlem özelliklerini yapılandırma.

API'yi kullanarak işlem kaydı politikalarını yönetme

Aşağıdaki bölümlerde, API kullanılarak işlem kaydetme politikalarının nasıl yönetileceği açıklanmaktadır.

API'yi kullanarak işlem kaydetme politikası oluşturma

İşlem kaydetme politikasını bir API ürününün özelliği olarak belirtirsiniz. The value of özelliğinin tanımı:

• İşlem kaydetme politikasının geçerli olduğu ürün kaynağının URI soneki ekli. Sonek, süslü ayraçlar içine alınmış bir kalıp değişkeni içerir. Desen değişkeni çalışma zamanında API Hizmetleri tarafından değerlendirilir. Örneğin, aşağıdaki URI soneki {id} kalıp değişkenini içerir.

  /reserve/{id}**
  

  Bu durumda API Hizmetleri, kaynağın URI sonekini /reserve ve ardından API'nin tanımladığı bir kimlikle başlayan herhangi bir alt dizin sağlar.

• Eklendiği yanıttaki kaynak. Bir API ürününde birden fazla kaynaklar ve her kaynak, bu kaynağı kullanmıyorsunuz.
• İşlem kaydetme politikasının içerik çıkarmasını sağlayan bir değişken ayıklama politikası için bir yanıt mesajından kaldırmanız gerekir.

PUT isteği göndererek bir API ürününe işlem kaydetme politikası özelliğini eklersiniz. management API'ye https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id}. (para kazanma API'sine değil).

API'yi kullanarak işlem başarısı ölçütlerini belirtme

Bir işlemin ne zaman başarılı olduğunu belirlemek için işlem başarı kriterleri belirtebilirsiniz. (şarj amacıyla). Başarılı olmayan (yani ölçütleri karşılayan işlemler) ifadesi) kaydedilir, ancak ücret planları bunlara uygulanmaz. Örnek olarak başarı kriterlerini görebilir, İşlem kaydetme politikasında işlem başarı kriterlerinin belirlenmesiyle ilgili örnekler.

İşlem başarı kriterlerini bir API ürününün özelliği olarak belirtirsiniz. Bu işlemi şu tarihe kadar yapın: management API'ye PUT isteği gönderme https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id}. (para kazanma API'sine değil).

Örneğin, aşağıdaki istekte Yeni txProviderStatus: success (işlem başarı kriterleriyle ilişkili) özellikleri vurgulanmıştır).

$ curl -H "Content-Type: application/json" -X PUT -d \ 
'{
        "apiResources": [
        "/reserve/{id}**"       
        ],
        "approvalType": "auto",
        "attributes": [                         
        {
                "name": "MINT_TRANSACTION_SUCCESS_CRITERIA",
                "value": "txProviderStatus == 'OK'"
        }
        ],
        "description": "Payment",
        "displayName": "Payment",
        "environments": [
        "dev"
        ],
        "name": "payment",
        "proxies": [],
        "scopes": [
        ""
        ]
}' \
"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/payment" \
-u email:password

API'yi kullanarak özel özellikler belirtme

Taban ücret planı aldığınız bir API ürünü için özel özellikler belirtebilirsiniz. Örneğin, Örneğin, her işlem için geliştiriciden ödeme aldığınız bir ücret listesi planı oluşturursanız planın ücretini, aktarılan bayt sayısı gibi özel bir özelliğe göre ayarlayabilir unutmayın. Ücret planı oluşturduğunuzda, temel alınacak bir metriktir. Ancak bir ücret planındaki belirli bir ürün, yalnızca planın ücretine dayanacak bir özel özellik.

Özel özellikleri, bir API ürününün özellikleri olarak belirtirsiniz. Bunu bir PUT numarası vererek yapın management API'ye yapılan istek https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id}. (para kazanma API'sine değil).

Bir API ürününe eklediğiniz her özel özellik için bir ad ve özellik değeri. Ad MINT_CUSTOM_ATTRIBUTE_{num} biçiminde olmalıdır. Burada {num} bir tam sayıdır.

Örneğin, aşağıdaki istek üç özel özellik belirtir.

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
        "apiResources": [
        "/reserve/{id}**",
        "/charge/{id}**"
        ],
        "approvalType": "auto",
        "attributes": [
        {
                "name": "MINT_CUSTOM_ATTRIBUTE_1",
                "value": "test1"
        },
        {
                "name": "MINT_CUSTOM_ATTRIBUTE_2",
                "value": "test2"
        }
 
        ],
        "name": "payment",
        "proxies": [],
        "scopes": [
                ""
        ]
}' \
"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/payment" \
-u email:password

Bir işlemde işlem başarı kriterlerini belirlemeye ilişkin örnekler kayıt politikası

Aşağıdaki tabloda, başarılı ve başarısız işlem örnekleri verilmiştir. Bu örnekler şunlardır: İşlem başarı ölçütü ifadesi ve döndürülen txProviderStatus değeri son verilere sahip olur. txProviderStatus, para kazanma özelliğinin kullandığı dahili değişkendir başarılı olup olmadığını belirlememiz gerekir.