Skonfiguruj plan udziału w przychodach

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Wprowadzenie

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

W przypadku modelu udziału stałego deweloper otrzymuje od Ciebie stały procent przychodów wygenerowanych z każdej transakcji (na podstawie ceny brutto lub netto transakcji). W ramach modelu elastycznego podziału przychodów dzielisz się z deweloperem zmiennym odsetkiem przychodów. Udział w przychodach zależy od przychodów wygenerowanych w danym okresie. Procent użyty do obliczenia udziału w przychodach może się różnić w zależności od wysokości przychodów wygenerowanych przez transakcje.

Określanie szczegółów planu dzielenia się przychodami za pomocą interfejsu

Skonfiguruj plany udziału w przychodach zgodnie z opisem poniżej.

Określanie szczegółów planu dzielenia się przychodami za pomocą interfejsu API

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

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

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

• Parametr oceny, który wskazuje, że plan stawek jest oparty na transakcjach (VOLUME). Domyślna wartość to VOLUME.
• typ pomiaru (UNIT), który wskazuje, że udział w przychodach jest stały na jednostkę (czyli nie zależy od liczby transakcji, jak w przypadku elastycznego modelu podziału).
• Typ przychodu (GROSS lub NET). Określa, czy udział w przychodach jest obliczany na podstawie ceny brutto czy netto transakcji.
• Termin płatności (np. 30 dni).
• Identyfikator organizacji.
• „Podstawowa” waluta księgowa, której używa Twoja firma.
• stawka planu cenowego, 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 wybrać tylko 1 stawkę w ramach abonamentu.

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

W ramach stawki planu cenowego określasz:

• Typ stawki abonamentu (REVSHARE).
• Wartość procentowa służąca do obliczenia udziału w przychodach. Jeśli np. określisz wartość 80,5555, udział w przychodach wyniesie 80,5555%, co oznacza, że jako dostawca interfejsu API płacisz deweloperowi 80,5555% ceny pobieranej za każdą transakcję (lub jeśli jest to wartość oparta na atrybucie niestandardowym, takim jak liczba bajtów przesłanych w ramach transakcji, płacisz deweloperowi 80,5555% ceny pobieranej za przesłanie określonej liczby bajtów).
• Jednostka początkowa stawki (0). Oznacza to, że stawka jest stosowana do każdej transakcji, począwszy od pierwszej.

Pełną listę właściwości planów cenowych znajdziesz w artykule Właściwości konfiguracji planów cenowych.

Na przykład poniższy kod tworzy plan udziału w przychodach z modelem udziału stałego. Udział w przychodach wynosi 80,5555%. Udział w przychodach jest obliczany na podstawie ceny netto transakcji. Umowa obowiązuje od 15 września 2013 r., a termin płatności upływa za 30 dni. (Wyróżnione są szczegóły dotyczące udziału w przychodach).

$ 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 (wyświetla się 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 dla elastycznego modelu udostępniania

W elastycznym modelu udostępniania określasz szczegóły abonamentu, które obejmują co najmniej 1 stawkę abonamentu. Każda stawka planu cenowego obejmuje pewien zakres przychodów z transakcji (każdy zakres nazywa się „pasmem przychodów”). Dla każdego przedziału przychodów możesz przypisać procentowy udział w przychodach.

Oprócz stawek planu taryfowego w szczegółach planu taryfowego musisz podać:

• 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 ustalany na podstawie liczby transakcji (czyli nie jest stały, jak w przypadku modelu z stałym udziałem).
• Typ przychodu (GROSS lub NET). Określa, czy udział w przychodach jest obliczany na podstawie ceny brutto czy netto transakcji.
• Termin płatności (np. 30 dni).
• Identyfikator organizacji.
• „Podstawowa” waluta księgowa, której używa Twoja firma.
• Czas trwania i jego typ, które razem określają okres, w którym przychody są agregowane (nazywany też „podstawą agregacji”). Transakcje są agregowane na podstawie wybranej podstawy agregacji (np. 1 miesiąc), aby obliczyć łączne przychody i odpowiednią grupę przychodów. Procentowy udział w przychodach stosowany w przypadku każdej transakcji zależy od przedziału przychodów.
• Liczniki agregacji, które służą do określania odpowiedniego przedziału przychodów.

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

W przypadku każdej stawki planu cenowego określasz:

• Typ stawki abonamentu w zakresie przychodów (REVSHARE).
• Odsetek używany do obliczania udziału w przychodach w przypadku przedziału przychodów. Jeśli np. podasz wartość 80,5555, udział w przychodach dla danego przedziału przychodów wyniesie 80,5555%, co oznacza, że jako dostawca interfejsu API płacisz deweloperowi 80,5555% ceny pobieranej za każdą transakcję w tym przedziale przychodów.
• Początkowa i końcowa jednostka zakresu przychodów. Jednostka początkowa określa dolną granicę przedziału przychodów, a jednostka końcowa – górną granicę tego przedziału. Jeśli np. podasz jednostkę początkową równą 0, a jednostkę końcową równą 1000, zakres przychodów obejmuje przychody z transakcji większe od 0 do 1000 w określonej walucie. Jeśli waluta to dolar amerykański, podstawa agregacji to 1 miesiąc, a procentowy udział w przychodach to 80,5555%, to w przypadku transakcji, które generują do 1000 USD przychodów w danym miesiącu, udział w przychodach wynosi 80,5555% ceny transakcji.

  Jeśli nie określisz końcowej jednostki dla ostatniego przedziału przychodów, odsetek udziału w tym przedziale będzie stosowany do wszystkich transakcji po przekroczeniu przez łączne przychody wartości początkowej tego przedziału. Jeśli na przykład jednostka początkowa ostatniego przedziału wynosi 1000 (w dolarach amerykańskich), a Ty nie określisz jednostki końcowej dla tego przedziału, odsetek przychodów w tym przedziale zostanie zastosowany do wszystkich transakcji o przychodach wyższych niż 1000 USD w okresie zbiorczym.

Pełną listę właściwości planów cenowych znajdziesz w artykule Właściwości konfiguracji planów cenowych.

Na przykład poniższy kod tworzy plan podziału przychodów z elastycznym modelem dzielenia. określa 2 pasma przychodów. Pierwszy przedział obejmuje przychody z transakcji o wartości do 1000 USD. Drugi przedział obejmuje przychody z transakcji przekraczające 1000 USD. Odsetek udziału w przychodach wynosi 80,5555% w przypadku pierwszego przedziału przychodów i 90,5% w przypadku drugiego przedziału przychodów. Udział w przychodach jest obliczany na podstawie ceny netto transakcji. Podstawą agregacji jest 1 miesiąc. Okres obowiązywania umowy rozpoczyna się 15 września 2013 r., a termin płatności upływa za 30 dni. (Wyróżnione są szczegóły dotyczące udziału 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 (wyświetla się 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"
}