Konfigurowanie planu stawek za pomocą atrybutów niestandardowych

Przeglądasz dokumentację Apigee Edge.
Przejdź do Dokumentacja Apigee X. informacje.

Wprowadzenie

W niektórych przypadkach liczniki transakcji mogą być oparte na zmiennej lub wartości niestandardowej. Możesz na przykład potrzebować:

• obciążają deweloperów zmienną kwotę na podstawie wartości podanej w komunikacie interfejsu API; . Na przykład możesz określić opłaty dla deweloperów aplikacji w zależności od liczby bajtów. przesyłane w żądaniu do interfejsu API.
• Łączenie wielu wywołań interfejsu API w jedną transakcję.

Korzystając z planów stawek z atrybutami niestandardowymi, możesz zidentyfikować wartość w komunikacie interfejsu API które działa jak licznik i służy do obliczania liczby transakcji i obciążeń.

Obsługiwane są te plany stawek z atrybutami niestandardowymi:

• Arkusz stawek z atrybutem niestandardowym
• Dostosowanie powiadomienia z niestandardowym atrybutem

W każdym planie stawek możesz ustawić maksymalnie 10 atrybutów niestandardowych.

Obliczenia atrybutów niestandardowych

Jak wartość atrybutu niestandardowego jest uwzględniana w liczbie transakcji i opłatach w ramach abonamentu zależy od modelu ładowania, tak jak pokazano w tej tabeli.

Skąd plan taryfowy uzyskuje wartość atrybutu niestandardowego

Zasady rejestrowania transakcji (w pakiecie usług API) informują, gdzie zarabiać dla wartości atrybutu niestandardowego. Atrybut niestandardowy definiujesz w atrybutach niestandardowych zasad rejestrowania transakcji dla pakietu produktów API.

Następnie możesz wybrać ten atrybut niestandardowy w planie stawek – po utworzeniu interfejsu API pakiet produktów, który zawiera zasady rejestrowania transakcji z .

Oto ogólny proces:

1. Zdefiniuj atrybuty niestandardowe podczas dodawania usługi interfejsu API.
2. Utwórz pakiet produktów API zawierający produkt.
   W zasadach rejestrowania transakcji dotyczących pakietu produktów API dodaj atrybuty niestandardowe, które będą używane do definiowania planów stawek.
3. Utwórz plan stawek typu arkusz stawek lub powiadomienie z możliwością dostosowania. dla pakietu produktów API i określ niestandardowy parametr oceny.

Na rysunku poniżej przedstawiono relację między atrybutem niestandardowym zdefiniowanym w zasad rejestrowania transakcji i konfiguracji planu arkusza stawek. powiadomienie z możliwością dostosowania z relacją planu stawek atrybutów niestandardowych jest podobne, ale wartość ograniczona według ilości nie ma zastosowania.

Jak wygenerować niestandardową wartość atrybutu w wiadomości

Zasada rejestrowania transakcji może szukać wartości atrybutu niestandardowego w kilku miejscach, takich jak nagłówek, treść odpowiedzi lub wstępnie zdefiniowane zmienne procesu w odpowiedzi. (Prośba jest niedostępna, ponieważ transakcja nie jest oficjalna dopóki nie zostanie zrealizowana response.) Poniżej znajdziesz przykłady dodawania nagłówka odpowiedzi z atrybutem swoją wartość liczbową. W obu przypadkach stosujemy zasady przypisywania wiadomości w w połączeniu ze zmiennymi.

Dodanie rozmiaru ładunku żądania do nagłówka odpowiedzi

W każdym żądaniu wiadomości znajduje się zmienna client.received.content.length, która zawiera liczbę bajtów w ładunku żądania. Dołącz zasadę Przypisz wiadomości do Odpowiedź punktu końcowego serwera proxy, możemy wygenerować nagłówek odpowiedzi messageSize, który zawiera wartość długości:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="messageSize">{client.received.content.length}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

dodanie wartości niestandardowego atrybutu aplikacji do nagłówka;

W podobny sposób możemy wygenerować nagłówek z wartością atrybutu niestandardowego w aplikacji. Jeśli na przykład uwzględnisz atrybut niestandardowy o nazwie apprating w przypadku każdego dewelopera w następujący sposób:

Jeśli używasz zasady weryfikacji klucza interfejsu API (wymaganej do zarabiania), ta wartość wynosi przechowywane w zmiennej o nazwie verifyapikey.{policy_name}.apprating. Korzystanie z karty Przypisz zasady wiadomości dołączonej do odpowiedzi punktu końcowego serwera proxy można wygenerować nagłówek o nazwie apprating zawierający wartość apprating aplikacji:

<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Message-1">
    <DisplayName>Assign Message 1</DisplayName>
    <Set>
        <Headers>
          <Header name="apprating">{verifyapikey.Verify-API-Key-1.apprating}</Header> 
        </Headers>  
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Konfigurowanie abonamentu

Poza opisaną powyżej konfiguracją atrybutu niestandardowego plan stawek konfiguruje się w ten sam sposób. tak jak zwykle (w przypadku planów stawek bez atrybutów niestandardowych), ale musisz przestrzegać poniższe wymagania.

Konfigurowanie planu arkusza stawek z atrybutem niestandardowym za pomocą interfejsu użytkownika

Skonfiguruj plany arkusza stawek z atrybutami niestandardowymi za pomocą interfejsu Edge lub klasycznego Edge zgodnie z opisem w kolejnych sekcjach.

Konfigurowanie możliwych do dostosowania planu powiadomień z atrybutami niestandardowymi za pomocą interfejsu użytkownika

Określanie szczegółów abonamentu z atrybutami niestandardowymi za pomocą interfejsu API

Wykonaj te czynności wstępne:

1. W zasadach rejestrowania transakcji usługi API dodaj atrybuty niestandardowe, które będą używane do definiowania planów stawek. Szczegółowe informacje zawierają wprowadzenie do tego tematu, a także artykuł Tworzenie transakcji zasady nagrywania. Zrób to w przypadku każdej usługi API, którą chcesz umieścić w pakiecie interfejsów API.
2. Gdy usługi API i zasady rejestrowania transakcji zostaną skonfigurowane dokładnie tak, jak Ty utwórz pakiet API zawierający dany produkt. Zobacz Tworzenie pakietów interfejsów API.

Następnie tworzysz plan stawek za pomocą interfejsu API.

Szczegóły planu stawek określasz przy użyciu atrybutów niestandardowych podczas jego tworzenia. Ty określ szczegóły we właściwości ratePlanDetails w treści żądania w polu połączenie z numerem /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. W szczegółów, określasz wartość parametru oceny, która identyfikuje nazwę niestandardowej . Możesz też podać wartość parametru oceny, która gromadzi atrybut niestandardowy w określonym przedziale czasu.

Zobacz abonament szczegóły konfiguracji, gdzie znajdziesz pełną listę opcji szczegółów abonamentu.

Poniższy przykład pokazuje arkusz stawek z planem atrybutów niestandardowych na podstawie o nazwie messageSize (elementy są pogrubione).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
   "name": "Custom attribute-based rate card plan",
   "developer":null,
   "developerCategory":null,
   "currency": {
     "id" : "usd"
     },     
   "description": "Custom attribute-based rate card plan",
   "displayName" : "Custom attribute-based rate card plan",
   "frequencyDuration": "1",
   "frequencyDurationType": "MONTH",
   "earlyTerminationFee": "10",
   "monetizationPackage": {
      "id": "location"
        },
      "organization": {
       "id": "{org_name}"
      },    
   "paymentDueDays": "30",
   "prorate": "false",
   "published": "false",     
   "ratePlanDetails":[
      {
        "currency":{
           "id":"usd"
        },
      "duration":1,
      "durationType":"MONTH",
      "meteringType":"VOLUME",
      "paymentDueDays":"30",
      "ratingParameter":"messageSize",
      "ratingParameterUnit":"MB",
      "organization":{
         "id":"{org_name}"
      },
      "ratePlanRates":[
         {
           "rate":0.15,
           "startUnit":0,
           "type":"RATECARD",
           "endUnit":1000
         },
         {
           "rate":0.1,
           "startUnit":1000,
           "type":"RATECARD",
           "endUnit":null
         }
      ],
      "freemiumUnit":0,
      "freemiumDuration":0,
      "freemiumDurationType":"MONTH",
      "type":"RATECARD",
      "customPaymentTerm":false
      }
    ],
    "freemiumUnit":0,
    "freemiumDuration":0,
    "freemiumDurationType":"MONTH",
    "contractDuration":"1",
    "contractDurationType":"YEAR", 
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "recurringFee": "10",
    "setUpFee": "10",
    "startDate": "2013-09-15 00:00:00",
    "type": "STANDARD"
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/monetization-packages/location/rate-plans" \
-u email:password

Czynność poniżej tworzy powiadomienie z możliwością dostosowania z planem stawek atrybutów niestandardowych na podstawie atrybut niestandardowy o nazwie messageSize (element pogrubiony).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "AdjustableNotification",
     "displayName": "Custom attribute-based adjustable notification plan",
     "description": "Custom attribute-based adjustable notification plan",
     "published": "true",  
     "organization": {
      "id": "myorg"
     },
     "startDate": "2016-04-15 00:00:00",
     "type": "STANDARD",
     "monetizationPackage": {
        "id": "p1",
        "name": "test"
     },
     "currency": {
        "id" : "usd",
        "name" : "USD"
     },
     "ratePlanDetails": [
        {
           "type": "USAGE_TARGET",
           "meteringType": "DEV_SPECIFIC",
           "duration": 1,
           "durationType": "MONTH",
           "ratingParameter": "messageSize",
           "ratingParameterUnit": "MB",
           "organization": {
             "id": "myorg"
           },
           "currency": {
             "id": "usd",
             "name": "USD"
           }
        }
     ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/monetization-packages/p1/rate-plans"  \
-u email:password