Skonfiguruj plan udziału w przychodach

Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje

Wstęp

W planie udziału w przychodach dostawca interfejsu API udostępnia deweloperowi odsetek przychodów uzyskanych z każdej transakcji (na podstawie ceny brutto lub netto z transakcji). Podczas tworzenia planu udziału w przychodach musisz wskazać model udziału, który może być stały lub elastyczny, oraz podstawę cenową (na przykład to, czy udział w przychodach jest oparty na cenie brutto czy netto z transakcji). Cenę brutto lub cenę netto transakcji określasz podczas tworzenia zasad rejestrowania transakcji.

W modelu stałego udostępniania udostępniasz deweloperowi stały procent przychodów wygenerowanych w każdej transakcji (na podstawie ceny brutto lub netto z transakcji). W modelu elastycznego udostępniania dzielisz się z deweloperem zmienną procentową udziału w przychodach. Udział w przychodach zależy od przychodów wygenerowanych w danym okresie. Wartość procentowa używana do obliczania udziału w przychodach może się różnić w zależności od kwoty przychodów wygenerowanych przez transakcje.

Określanie szczegółów planu udziału w przychodach za pomocą interfejsu

Skonfiguruj plany udziału w przychodach w sposób opisany poniżej.

Określanie szczegółów planu udziału w przychodach przy użyciu interfejsu API

Szczegóły planu udziału w przychodach określasz podczas tworzenia planu stawek. Szczegóły określasz we właściwości ratePlanDetails w treści żądania w wywołaniu /organizations/{org_name}/monetization-packages/{package_id}/rate-plans. To, co określisz we właściwości ratePlanDetails, zależy od wybranego modelu udostępniania: stałego lub elastycznego.

Określanie szczegółów planu udziału w przychodach w przypadku stałego modelu udziału

Aby wdrożyć stały model udostępniania, w szczegółach abonamentu podaj te informacje:

• Parametr oceny, który wskazuje, że plan stawek jest oparty na transakcjach (VOLUME). Wartość domyślna to VOLUME.
• Typ pomiaru (UNIT), który wskazuje, że udział w przychodach jest stały przypadający na jednostkę (czyli nie jest uzależniony od liczby transakcji, jak w przypadku modelu elastycznego udostępniania).
• Typ przychodów (GROSS lub NET). Wskazuje, czy udział w przychodach jest obliczany na podstawie ceny brutto czy netto transakcji.
• Termin płatności (np. 30 dni).
• Identyfikator Twojej organizacji.
• Waluta podstawowa lub księgowa, której używa Twoja firma.
• Stawka dla abonamentu, która zawiera szczegółowe informacje o sposobie obliczania udziału w przychodach. Model udostępniania opiera się na stałej stawce, więc możesz określić tylko jedną stawkę abonamentu.

Pełną listę właściwości szczegółów abonamentu znajdziesz w sekcji Właściwości konfiguracji szczegółów abonamentu.

W stawce planu stawek określasz:

• Typ stawki w ramach abonamentu (REVSHARE).
• Wartość procentowa używana do obliczania udziału w przychodach. Jeśli na przykład podasz 80,5555, udział w przychodach wyniesie 80,5555%, co oznacza, że jako dostawca interfejsu API zapłacisz deweloperowi 80,5555% ceny pobieranej za każdą transakcję (lub jeśli zgodnie z atrybutem niestandardowym, takim jak liczba bajtów przesłanych w transakcji, zapłacisz deweloperowi 80,5555% ceny za każdą transakcję).
• Początkowa jednostka zastosowania stawki (0). Oznacza to, że stawka jest stosowana do każdej transakcji, począwszy od pierwszej transakcji.

Pełną listę właściwości planu stawek znajdziesz w sekcji Właściwości konfiguracji abonamentów.

Poniższy przykład przedstawia plan udziału w przychodach ze stałym modelem udziału. Procentowy udział w przychodach wynosi 80,5555%. Udział w przychodach jest obliczany na podstawie ceny netto transakcji. Umowa wchodzi w życie 15 września 2013 roku. Termin płatności upływa za 30 dni. (szczegóły związane z udziałem w przychodach będą wyróżnione).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
    "name": "Fixed share plan",
    "developer":null,
    "developerCategory":null,
    "advance": false,
    "currency": {
      "id": "usd"
    },
    "description": "Fixed share plan",
    "displayName": "Fixed share plan",
    "earlyTerminationFee": 10,    
    "monetizationPackage": {
      "id": "location"
    },    
    "organization": {
      "id": "{org_name}"
    },
    "paymentDueDays": "30",
    "prorate": false,
    "published": true,
    "ratePlanDetails": [
      {
        "aggregateStandardCounters": true,
        "currency": {
         "id": "usd"
        },
        "duration": 1,
        "durationType": "MONTH",
        "meteringType": "UNIT",
        "organization": {
         "id": "{org_name}"
        },
        "paymentDueDays": "30",
        "ratePlanRates": [
         {
          "revshare": 80.8555,
          "startUnit": 0,
          "type": "REVSHARE"
         }
        ],
        "ratingParameter": "VOLUME",
        "revenueType": "NET",
        "type": "REVSHARE"
      }
    ],
    "recurringStartUnit": 1,
    "recurringType": "CALENDAR",
    "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

Odpowiedź powinna wyglądać tak (widoczna jest tylko część odpowiedzi):

{
  "advance" : false,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    ...
    "organization" : {
      ...
    },
   ...
  },
  "description" : "Fixed share plan",
  "displayName" : "Fixed share plan",
  "earlyTerminationFee" : 10,
  "id" : "location_fixed_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
     ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Fixed share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : true,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
      ...
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "c1720153-c60f-4f7f-b4e5-cdc7bc7bec5b",
    "meteringType" : "UNIT",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "id" : "01c4d544-d907-423b-964e-4e2aed2816a3",
      "revshare" : 80.8555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}

Określanie szczegółów planu udziału w przychodach na potrzeby elastycznego modelu udziału

W modelu elastycznego udostępniania określasz szczegóły planu stawek, które obejmują co najmniej 1 stawkę abonamentu. Każda stawka abonamentu obejmuje zakres przychodów z transakcji (każdy zakres jest nazywany „przedziałem przychodów”). Do każdego zakresu przychodów przypisujesz procent udziału w przychodach.

Oprócz stawek planu stawek w szczegółach abonamentu podajesz też te informacje:

• Parametr oceny, który wskazuje, że plan stawek jest oparty na transakcjach (VOLUME). Wartość domyślna to VOLUME.
• Typ pomiaru (VOLUME), który wskazuje, że udział w przychodach nie jest uzależniony od liczby transakcji (nie jest stały, jak ma to miejsce w przypadku modelu stałego udostępniania).
• Typ przychodów (GROSS lub NET). Wskazuje, czy udział w przychodach jest obliczany na podstawie ceny brutto czy netto transakcji.
• Termin płatności (np. 30 dni).
• Identyfikator Twojej organizacji.
• Waluta podstawowa lub księgowa, której używa Twoja firma.
• Typ czasu trwania i czasu trwania, które razem określają okres, w którym przychody są sumowane (jest to też nazywane „podstawą agregacji”). Transakcje są przedstawiane zbiorczo (np. z jednego miesiąca), aby obliczyć łączne przychody i odpowiedni przedział przychodów. Procentowy udział w przychodach stosowany do każdej transakcji zależy od zakresu przychodów.
• Liczniki agregacji służące do określania odpowiedniego zakresu przychodów.

Pełną listę właściwości szczegółów abonamentu znajdziesz w sekcji Właściwości konfiguracji szczegółów abonamentu.

W przypadku każdej stawki w ramach abonamentu określasz te stawki:

• Typ stawki abonamentu dla zakresu przychodów (REVSHARE).
• Wartość procentowa używana do obliczania udziału w przychodach w przypadku danego zakresu przychodów. Jeśli na przykład podasz 80, 5555, udział w przychodach dla zakresu przychodów wyniesie 80,5555%, czyli jako dostawca interfejsu API zapłacisz deweloperowi 80, 5555% ceny naliczonej za każdą transakcję w tym przedziale przychodów.
• Początkowa i końcowa jednostka zakresu przychodów. Jednostka początkowa określa dolny limit zakresu przychodów, a jednostka końcowa – górny limit tego zakresu. Jeśli na przykład określisz jednostkę początkową 0 i jednostkę końcową 1000, zakres przychodów będzie obejmować przychody z transakcji większe od 0 do 1000 w określonej walucie. Jeśli walutą jest dolar amerykański, podstawą agregacji jest 1 miesiąc, a w przypadku zakresu przychodów wynosi 80,5555%. W przypadku transakcji, które generują do 1000 USD przychodów w miesiącu, udział w przychodach wynosi 80,5555% ceny transakcji.

  Jeśli nie określisz jednostki końcowej dla ostatecznego zakresu przychodów, odsetek udziału dla tego zakresu będzie stosowany do wszystkich transakcji, gdy łączne przychody przekroczą jednostkę początkową dla tego zakresu. Jeśli na przykład jednostka początkowa ostatniego zakresu to 1000 (przy założeniu, że wynosi się w dolarach amerykańskich) i nie określisz jednostki końcowej dla tego zakresu, procent przychodów dla tego zakresu zostanie zastosowany do wszystkich transakcji powyżej 1000 USD przychodu w okresie zbiorczym.

Pełną listę właściwości planu stawek znajdziesz w sekcji Właściwości konfiguracji abonamentów.

Poniższy przykład ilustruje sposób utworzenia planu udziału w przychodach z elastycznym modelem udostępniania. Określa 2 zakresy przychodów. Pierwszy zakres obejmuje przychody z transakcji większe niż do 1000 dolarów amerykańskich. Drugi zakres obejmuje przychody z transakcji przekraczające 1000 USD. Procentowy udział w przychodach wynosi 80,5555% w pierwszym zakresie przychodów i 90,5% w drugim. Udział w przychodach jest obliczany na podstawie ceny netto transakcji. Podstawą agregacji jest 1 miesiąc. Umowa obowiązuje od 15 września 2013 r., a termin płatności upływa za 30 dni. (wyróżnione są szczegóły związane z udziałem w przychodach).

$ curl -H "Content-Type:application/json" -X POST -d \
'{
     "name": "Flexible share plan",
     "developer":null,
     "developerCategory":null,
     "advance": "true",
     "currency": {
      "id": "usd"
     },
     "description": "Flexible share plan",
     "displayName": "Flexible share plan",   
     "frequencyDuration": "30",
     "frequencyDurationType": "DAY",
     "earlyTerminationFee": "10",       
     "monetizationPackage": {
      "id": "location"
     },
     "organization": {
      "id": "{org_name}"
     },
     "paymentDueDays": "30",
     "prorate": "false",
     "published": "true",
     "ratePlanDetails": [
     {
      "currency": {
       "id": "usd"
      },
      "duration": "1",
      "durationType": "MONTH",
      "meteringType": "VOLUME",
      "organization": {
       "id": "{org_name}"
      },
      "paymentDueDays": "30",
      "ratePlanRates" : [ {
       "endUnit" : 1000,
       "revshare" : 80.5555,
       "startUnit" : 0,
       "type" : "REVSHARE"
      }, {
       "revshare" : 90.5,
       "startUnit" : 1000,
       "type" : "REVSHARE"
      } ],
     "ratingParameter" : "VOLUME",
     "revenueType" : "NET",
     "type" : "REVSHARE"
    } ],
    "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

Odpowiedź powinna wyglądać tak (widoczna jest tylko część odpowiedzi):

{
  "advance" : true,
  "currency" : {
    "id" : "usd",
    "name" : "USD",
    "organization" : {
      ...
    },
    ...
  },
  "description" : "Flexible share plan",
  "displayName" : "Flexible share plan",
  "earlyTerminationFee" : 10,
  "frequencyDuration" : 30,
  "frequencyDurationType" : "DAY",
  "id" : "location_flexible_share_plan",
  "monetizationPackage" : {
    "description" : "Location",
    "displayName" : "Location",
    "id" : "location",
    "name" : "Location",
    "organization" : {
      ...
    },
    "product" : [ {
      "customAtt1Name" : "user",
      "description" : "Location",
      "displayName" : "Location",
      "id" : "location",
      "name" : "location",
      "organization" : {
        ...
      },
      "status" : "CREATED"
    } ],
    "status" : "CREATED"
  },
  "name" : "Flexible share plan",
  "organization" : {
    ...
  },
  "paymentDueDays" : "30",
  "prorate" : false,
  "published" : false,
  "ratePlanDetails" : [ {
    "aggregateFreemiumCounters" : true,
    "aggregateStandardCounters" : true,
    "currency" : {
      "id" : "usd",
      "name" : "USD",
       …
      "organization" : {
        ...
      },
      ...
    },
    "duration" : 1,
    "durationType" : "MONTH",
    "id" : "ba3353e3-14f4-4bc5-a9f1-c723fd34131c",
    "meteringType" : "VOLUME",
    "organization" : {
      ...
    },
    "paymentDueDays" : "30",
    "ratePlanRates" : [ {
      "endUnit" : 1000,
      "id" : "5f13a51e-2250-4383-9aad-35e9a008ab40",
      "revshare" : 80.5555,
      "startUnit" : 0,
      "type" : "REVSHARE"
    }, {
      "id" : "d4196250-4ecc-480e-a7ed-dfab8e1c92ed",
      "revshare" : 90.5,
      "startUnit" : 1000,
      "type" : "REVSHARE"
    } ],
    "ratingParameter" : "VOLUME",
    "revenueType" : "NET",
    "type" : "REVSHARE"
  } ],
  "recurringFee" : 10,
  "recurringStartUnit" : 1,
  "recurringType" : "CALENDAR",
  "setUpFee" : 10,
  "startDate" : "2013-09-15 00:00:00",
  "type" : "STANDARD"
}