Esta é a documentação do Apigee Edge.
Acesse
Documentação da Apigee X. informações
Introdução
Em um plano de participação na receita, o provedor da API compartilha com o desenvolvedor uma porcentagem do a receita gerada de cada transação (com base no preço bruto ou líquido de uma transação). Quando Você cria um plano de participação na receita, precisa indicar um modelo de compartilhamento, que pode ser fixo ou flexível e uma base de preço (por exemplo, se a participação na receita é baseada no valor bruto ou líquido preço de uma transação). Você define o preço bruto ou líquido da transação ao criar a política de registro de transações.
No modelo de compartilhamento fixo, você compartilha com o desenvolvedor uma porcentagem fixa da receita gerados a partir de cada transação (com base no preço bruto ou líquido de uma transação). Na modelo de compartilhamento flexível, você compartilha com o desenvolvedor uma porcentagem variável da receita. A a participação na receita depende da receita gerada durante um período. A porcentagem usada O cálculo da participação na receita pode variar com base no valor da receita gerada pelas transações.
Especificar os detalhes do plano de participação na receita usando na interface
Configure planos de participação na receita, conforme descrito abaixo.
Edge
Para configurar um plano de participação na receita usando a interface do Edge, ao criar ou editar um plano de tarifas, selecione o tipo de plano de tarifas Participação na receita ou Tabela de preços e participação na receita e, na seção Participação na receita, configure as seguintes informações:
| Campo | Descrição |
| Modelo de cálculo | Selecione um dos seguintes tipos de preços:
|
| Frequência do cálculo | Período em que é calculado o volume de transações (ou o volume relacionado a atributos personalizados). Selecione um número de meses (1 a 24 meses). |
| Modelo de compartilhamento | Selecione um dos seguintes modelos de participação na receita:
|
| Participação na receita fixa | No modelo de compartilhamento fixo, especifica a porcentagem usada para calcular a participação na receita. Insira um número decimal (com até quatro casas decimais). Por exemplo, se você inserir 80,5555, a participação na receita será de 80,5555%, ou seja, como provedor de API, você pagará ao desenvolvedor 80,5555% do preço cobrado por cada transação. |
| Faixas de participação na receita | Para o modelo de compartilhamento flexível, um ou mais intervalos de receita da transação (cada intervalo é uma "faixa de receita"). É possível atribuir uma porcentagem de divisão da receita a cada faixa de receita. As transações são agregadas na base de agregação para calcular a receita total e a faixa de receita da transação. A porcentagem da participação na receita aplicada a cada transação depende da faixa de receita dela. Especifique o limite máximo da primeira faixa, por exemplo, até 1.000 (o limite inferior é predefinido para maior que 0). Clique em +Novo para adicionar outras faixas. Deixe o limite superior da faixa final em branco para indicar todas as transações depois que a receita agregada estiver acima desse nível. Por exemplo, se você especificar duas faixas de receita na seção Banda de receita (>0 a 1.000 e acima de 1.000), insira 80,5555 para a faixa de receita >0 a 1000 e 90, 5 para a de 1.000 e acima. Suponha também que a moeda esteja em dólares americanos. Então, para as transações que geram até US $1.000 em receita, a participação na receita é de 80,5555% do preço da transação. Para as transações que geram mais de US $1.000 em receita, a participação na receita é de 90,5% do preço da transação. |
Edge clássico (nuvem privada)
Para configurar planos de participação na receita usando a interface clássica do Edge:
- Siga as etapas para criar um plano de tarifas.
- Selecione Participação na receita no menu suspenso "Tipo de plano de taxa" para configurar o modelo de receita.
- Se o pacote de API selecionado incluir vários produtos de API, selecione uma das seguintes opções:
Observação: se o pacote da API incluir um único produto de API, pule esta etapa.
- Planos específicos do produto para configurar os detalhes do plano de tarifas de cada produto de API individualmente.
- Plano genérico para todos os produtos para configurar detalhes do plano de tarifas de todos os produtos de API.
- Clique em Participação na receita para o plano de tarifas genérico ou para cada plano de tarifas específico do produto da API.
Observação: ao configurar planos específicos para produtos de API, é necessário definir um plano de participação na receita para cada produto de API individualmente.
A janela "Participação na receita" será aberta.
- Selecione um dos seguintes modelos de compartilhamento:
- Fixa: nesse modelo, o provedor da API compartilha com o desenvolvedor uma porcentagem fixa do a receita gerada por cada transação (com base no preço bruto ou líquido de uma transação).
- Flexível: nesse modelo, o provedor da API compartilha com o desenvolvedor uma variável a porcentagem da receita. A participação na receita depende da receita gerada durante um período período. A porcentagem usada no cálculo da participação na receita pode variar com base no valor da receita gerada pelas transações.
Para o modelo de compartilhamento fixo:
Se você selecionar o modelo de compartilhamento fixo, insira as seguintes informações na coluna Preço da janela Participação na receita genérica:
Campo Descrição Operador (ou organização) O nome da organização. Esse campo é predefinido com o uso das teclas "Operador" (ou organização) no perfil da organização.
País O país de operação da sua organização. Esse campo é predefinido usando o Valor do campo "País" no perfil da organização.
Moeda A "base" ou moeda contábil que sua empresa usa. Este campo está predefinido usando o valor do campo "Moeda" no perfil da organização.
Tipo de preço A base da participação na receita. Selecione Bruto ou Líquido. Se você selecionar Bruto, o a participação na receita é baseada em uma porcentagem do preço bruto de uma transação. Se você Selecione Líquido, a participação nos lucros é baseada em uma porcentagem do preço líquido de um transação. Observação: você define o preço bruto ou líquido da transação ao criar a política de registro de transações.
% de compartilhamento fixo A porcentagem usada para calcular a participação na receita. Insira um número decimal (com com até quatro casas decimais). Por exemplo, se você inserir 80,5555, a divisão da receita será 80,5555%, ou seja, como provedor de API, você paga 80,5555% do preço ao desenvolvedor. cobrados para cada transação.
Para o modelo de compartilhamento flexível:
Se você selecionar o modelo de compartilhamento flexível, a janela de Participação na receita genérica vai aparecer exibe campos adicionais. Use esses campos para especificar uma base para agregação e para especificar "faixas de receita", ou seja, intervalos de receita gerada por transações para os quais é possível aplicar diferentes porcentagens de participação na receita.
Insira as seguintes informações na janela Generic Revenue Share:
Campo Descrição Base de agregação O período de agregação da receita. A receita agregada é usado para calcular a faixa de receita para cada transação (e a receita aplicável (percentual de compartilhamento). Selecione um número de meses (entre 1 e 12).
Faixas de receita Um ou mais intervalos de receita da transação (cada intervalo é uma "faixa de receita"). Cada a faixa de receita pode ser atribuída a uma porcentagem de participação na receita (você define essa porcentagem o campo Faixas de receita da seção Preço). As transações são agregadas ao longo base de agregação para calcular a receita total e a faixa de receita do transação. A porcentagem de participação na receita aplicada a cada transação depende da faixa de receita.
Especifique o limite máximo da primeira banda, por exemplo, até 1.000 (o valor está predefinido como maior que 0). Clique em "+" para adicionar uma segunda banda, por exemplo, de 1.000 a 2.000. Clique em "+" para adicionar mais faixas. Você pode deixar a parte superior limite da faixa final vazio para indicar todas as transações após a agregação a receita ficou acima desse nível.
Preços Operador (ou organização) O nome da organização. Esse campo é predefinido com o uso das teclas "Operador" (ou organização) no perfil da organização.
País O país de operação da sua organização. Esse campo é predefinido usando o Valor do campo "País" no perfil da organização.
Moeda A "base" ou moeda contábil que sua organização usa. Este campo é predefinida usando o valor do campo "Moeda" no perfil da organização.
Tipo de preço A base da participação na receita. Selecione Bruto ou Líquido. Se você selecionar Bruto, o a participação na receita é baseada em uma porcentagem do preço bruto de uma transação. Se você Selecione Líquido, a participação nos lucros é baseada em uma porcentagem do preço líquido de um transação. Observação: você define o preço bruto ou líquido da transação ao criar a política de registro de transações.
% de participação para faixas de receita A porcentagem usada para calcular a participação na receita das transações em cada faixa de receita. Você especifica uma porcentagem para cada faixa. Insira um número decimal com quatro casas decimais). Por exemplo, se você especificar duas faixas de receita no campo Receita seção (>0-1000 e 1000 e acima), você pode inserir 80.5555 para o >0-1.000 faixa de receita e 90, 5 para a faixa de 1.000 e acima de receita. Presumir também a moeda está em dólares americanos. Depois, para as transações que gerarem até US $1.000,00 em receita, a participação na receita será de 80,5555% do preço da transação, e para o transações que geram mais de US $1.000 em receita, a participação na receita será de 90,5% do o preço da transação.
- Clique em Aplicar e fechar para salvar os detalhes da divisão da receita e retornar à taxa padrão. Janela do plano.
- Para planos de preços específicos de produtos de API, configure os detalhes do plano para outros produtos de API, conforme necessário.
Como especificar os detalhes do plano de participação na receita usando a API
Você especifica os detalhes do plano de divisão da receita ao criá-lo. Você especifica os detalhes
na propriedade ratePlanDetails no corpo da solicitação em uma chamada para
/organizations/{org_name}/monetization-packages/{package_id}/rate-plans. O que você
especificar na propriedade ratePlanDetails, depende do modelo de compartilhamento escolhido:
fixos ou flexíveis.
Como especificar detalhes do plano de participação na receita para um modelo de compartilhamento fixo
Para implementar o modelo de compartilhamento fixo, especifique o seguinte nos detalhes do plano de tarifas:
- Um parâmetro de classificação que indica que o plano de tarifas é baseado em transações.
(
VOLUME).VOLUMEé o padrão. - Um tipo de medição (
UNIT) que indica que a participação na receita é fixa por unidade. (ou seja, não se baseia no volume de transações, como é o caso do modelo flexível ou modelo de compartilhamento). - O tipo de receita (
GROSSouNET). Isso indica se o a participação na receita é baseada no preço bruto ou líquido de uma transação. - O período de vencimento do pagamento (por exemplo, 30 dias).
- O ID da sua organização.
- A "base" ou moeda contábil que sua empresa usa.
- Uma taxa do plano de tarifação que fornece detalhes sobre como a participação na receita é calculada. Devido ao o modelo de compartilhamento se baseia em uma taxa fixa, você especifica apenas uma taxa de plano.
Consulte Propriedades da configuração para detalhes do plano de tarifa para uma lista completa de propriedades de detalhes do plano de tarifa.
Na taxa do plano de tarifa, você especifica:
- O tipo de taxa do plano de tarifação (
REVSHARE). - A porcentagem usada para calcular a participação na receita. Por exemplo, se você especificar 80,5555, a participação na receita é de 80,5555%, ou seja, como provedor de API, você paga 80,5555% ao desenvolvedor o preço cobrado por cada transação (ou se for baseado em um atributo personalizado, como o número de bytes transmitidos em uma transação, você paga 80,5555% do preço cobrado ao desenvolvedor transmitindo o número especificado de bytes).
- A unidade inicial do aplicativo de tarifa (
0). Isso significa que a taxa é aplicada a cada transação, começando pela primeira.
Consulte Propriedades de configuração de planos de tarifas para acessar a lista completa de propriedades do plano de tarifas.
Por exemplo, o código a seguir cria um plano de participação na receita com um modelo de compartilhamento fixo. A a porcentagem de participação na receita é de 80,5555%. A participação na receita é baseada no preço líquido de um transação. O contrato entra em vigor em 15 de setembro de 2013 e o pagamento vence em 30 dias. O detalhes relacionados à participação na receita estão destacados.)
$ 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
A resposta será semelhante a esta (apenas parte dela será mostrada):
{ "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" }
Como especificar detalhes do plano de participação na receita para um modelo de compartilhamento flexível
Em um modelo de compartilhamento flexível, você especifica detalhes do plano de tarifação que incluem um ou mais planos de tarifas. e as taxas de desempenho. Cada taxa de plano de tarifação cobre um intervalo de receita da transação (cada intervalo é chamado de banda"). Você atribui uma porcentagem de divisão da receita para cada faixa de receita.
Além das taxas do plano de tarifação, você especifica o seguinte nos detalhes do plano de tarifação:
- Um parâmetro de classificação que indica que o plano de tarifas é baseado em transações.
(
VOLUME).VOLUMEé o padrão. - Um tipo de medição (
VOLUME) que indica que a participação na receita não se baseia em o volume de transações (ou seja, ele não é fixo, como é o caso do modelo de modelo). - O tipo de receita (
GROSSouNET). Isso indica se o a participação na receita é baseada no preço bruto ou líquido de uma transação. - O período de vencimento do pagamento (por exemplo, 30 dias).
- O ID da sua organização.
- A "base" ou moeda contábil que sua empresa usa.
- Um tipo de duração e que, juntos, especificam o período de tempo em que a receita é agregados (isso também é chamado de "base de agregação"). As transações são agregadas ao longo base de agregação (por exemplo, 1 mês) para calcular a receita total e o valor faixa de receita. A porcentagem de participação na receita aplicada a cada transação depende da receita dela banda
- Contadores de agregação usados para determinar a faixa de receita aplicável.
Consulte Propriedades da configuração para detalhes do plano de tarifa para uma lista completa de propriedades de detalhes do plano de tarifa.
Para cada tarifa de plano de tarifa, você especifica:
- O tipo de taxa do plano de tarifação para a faixa de receita (
REVSHARE). - A porcentagem usada para calcular a participação na receita da banda. Por exemplo, se você especificar 80,5555, a participação na receita para a faixa de receita será de 80,5555%, ou seja, como uma API provedor, você paga ao desenvolvedor 80,5555% do preço cobrado por cada transação faixa de receita.
- A unidade inicial e final da faixa de receita. A unidade inicial especifica a menor
limite de uma faixa de receita, e a unidade final especifica o limite superior da banda de receita. Para
exemplo, se você especificar uma unidade inicial de 0 e uma unidade final de 1.000, a faixa de receita
abrange a receita de transações superior a 0 e até 1.000 na moeda especificada. Se o
moeda é o dólar americano, a base de agregação é um mês e a porcentagem da receita
for de 80,5555%, então, para transações que geram até US $1.000 em receita em um mês, a
a participação na receita é de 80,5555% do preço da transação.
Se você não especificar uma unidade final para a faixa de receita final, a porcentagem de compartilhamento essa banda seja aplicada a todas as transações depois que a receita agregada estiver acima do a unidade inicial dessa pulseira. Por exemplo, se a unidade inicial da última banda for 1000 (suponha em dólares americanos) e não especifique uma unidade final para essa banda, a receita a porcentagem da banda é aplicada a todas as transações acima de US $1.000 de receita durante o período agregado.
Consulte Propriedades de configuração de planos de tarifas para acessar a lista completa de propriedades do plano de tarifas.
Por exemplo, o código a seguir cria um plano de participação na receita com um modelo de compartilhamento flexível. Ela especifica duas faixas de receita. A primeira banda cobre a receita de transações superior a 1.000 em dólares americanos. A segunda cobre a receita de transações acima de 1.000 dólares americanos. A receita a porcentagem de participação é de 80,5555% para a primeira faixa de receita e 90,5% para a segunda. A participação na receita é baseada no preço líquido de uma transação. A base da agregação é de 1 mês. O período de contrato entra em vigor em 15 de setembro de 2013 e o pagamento vence em 30 dias. (A receita detalhes relacionados ao compartilhamento são destacados.)
$ 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
A resposta será semelhante a esta (apenas parte dela será mostrada):
{ "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" }